TRIM.SDK.SortAndFilterUserOptions Class Reference

Default search sorting and filtering More...

Inheritance diagram for TRIM.SDK.SortAndFilterUserOptions:

Public Member Functions
	SortAndFilterUserOptions (Database inDatabase)
	Constructor for the SortAndFilterUserOptions option set. More...
string	GetDefaultSort (BaseObjectTypes forObjectType)
	Gets the default sort order when searching for objects of the specified type and there is no specific purpose specified. More...
string	GetDefaultSort (BaseObjectTypes forObjectType, int forSpecialPurpose)
	Gets the default sort order when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific sort setting. More...
string	GetDefaultSort (LocationPurpose forLocationSearchType)
	Gets the default sort order when searching for locations and the search is for the specific purpose. More...
void	SetDefaultSort (BaseObjectTypes forObjectType, string newSortSpecification)
	Sets the default sort order when searching for objects of the specified type and there is no specific purpose specified. More...
void	SetDefaultSort (BaseObjectTypes forObjectType, int forSpecialPurpose, string newSortSpecification)
	Sets the default sort order when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific sort setting. More...
void	SetDefaultSort (LocationPurpose forLocationSearchType, string newSortSpecification)
	Sets the default sort order when searching for locations and the search is for the specific purpose. More...
string	GetDefaultFilters (BaseObjectTypes forObjectType)
	Gets the default filters to apply when searching for objects of the specified type. For locations, use the option to specify the defaults for the specific location purpose instead. More...
string	GetDefaultFilters (LocationPurpose forLocationSearchType)
	Gets the default filters to apply when searching for locations and the search is for the specific purpose. More...
string	GetDefaultFilters (BaseObjectTypes forObjectType, int forSpecialPurpose)
	Gets the default filters to apply when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific filter setting. More...
void	SetDefaultFilters (BaseObjectTypes forObjectType, string newFilters)
	Sets the default filters to apply when searching for objects of the specified type. For locations, use the option to specify the defaults for the specific location purpose instead. More...
void	SetDefaultFilters (LocationPurpose forLocationSearchType, string newFilters)
	Sets the default filters to apply when searching for locations and the search is for the specific purpose. More...
void	SetDefaultFilters (BaseObjectTypes forObjectType, int forSpecialPurpose, string newFilters)
	Sets the default filters to apply when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific sort setting. More...
Public Member Functions inherited from TRIM.SDK.TrimUserOptionSet
	TrimUserOptionSet (Database db, UserOptionSetIds setId)
	Base constructor, constructs a TRIM user option set of the specified option set type. More...
void	Save ()
	Permanently commits all changes made to this option set. More...
void	LoadFromGlobalSetting ()
	Load the administrators "global settings" for this option set More...
void	SaveAsGlobalSetting ()
	Save this set as the "global setting" for this option set More...
Public Member Functions inherited from TRIM.SDK.TrimPropertySet
TrimIcon	GetPropertyIcon (PropertyIds propertyId)
	Gets the icon value associated the a property of this object. More...
TrimMainObject	GetPropertyTrimObject (PropertyIds dnPropId)
string	GetPropertyString (PropertyIds dnPropId)
int	GetPropertyLong (PropertyIds dnPropId)
long	GetPropertyLong64 (PropertyIds dnPropId)
bool	GetPropertyBool (PropertyIds dnPropId)
TrimDateTime	GetPropertyDate (PropertyIds dnPropId)
TrimDecimal	GetPropertyDecimal (PropertyIds dnPropId)
TrimCurrency	GetPropertyCurrency (PropertyIds dnPropId)
TrimURI	GetPropertyUri (PropertyIds dnPropId)
bool	SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)
bool	SetPropertyString (PropertyIds dnPropId, string newValue)
bool	SetPropertyLong (PropertyIds dnPropId, int newValue)
bool	SetPropertyLong64 (PropertyIds dnPropId, long newValue)
bool	SetPropertyBool (PropertyIds dnPropId, bool newValue)
bool	SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)
bool	SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)
bool	SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)
bool	SetPropertyDouble (PropertyIds dnPropId, double newValue)
bool	SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)
bool	ClearProperty (PropertyIds dnPropId)
object	GetProperty (PropertyIds propId)
bool	SetProperty (PropertyIds propId, object newValue)
string	GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
	Gets a string representation of a property value in a format appropriate for a specific use. More...
bool	IsMandatory (PropertyIds propertyId)
	Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...
bool	VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
	Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...
bool	CanModifyProperty (PropertyIds propertyId)
	Indicates whether the current user has the permission to modify the specified property. More...

Additional Inherited Members
Properties inherited from TRIM.SDK.TrimUserOptionSet
UserOptionSetIds	OptionSetType [get]
bool	IsReadOnly [get]
	Gets a BaseObjectTypes enum value indicating the type of this object. Gets a boolean parameter indicating if this option set has been locked down and is therefore unable to be modified. More...
Properties inherited from TRIM.SDK.TrimPropertySet
string	ErrorMessage [get]
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
TrimException	Error [get]
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
Database	Database [get]
	Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...
virtual string	Caption [get]
	Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...
virtual TrimIcon	Icon [get]
	Gets the icon value associated this TrimPropertySet. More...
bool	IsModified [get]
	Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...

Detailed Description

Default search sorting and filtering

Constructor & Destructor Documentation

SortAndFilterUserOptions()

TRIM.SDK.SortAndFilterUserOptions.SortAndFilterUserOptions

(

Database

inDatabase

)

Constructor for the SortAndFilterUserOptions option set.

Member Function Documentation

GetDefaultFilters() [1/3]

string TRIM.SDK.SortAndFilterUserOptions.GetDefaultFilters

(

BaseObjectTypes

forObjectType

)

Gets the default filters to apply when searching for objects of the specified type. For locations, use the option to specify the defaults for the specific location purpose instead.

GetDefaultFilters() [2/3]

string TRIM.SDK.SortAndFilterUserOptions.GetDefaultFilters	(	BaseObjectTypes	forObjectType,
		int	forSpecialPurpose
	)

Gets the default filters to apply when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific filter setting.

GetDefaultFilters() [3/3]

string TRIM.SDK.SortAndFilterUserOptions.GetDefaultFilters

(

LocationPurpose

forLocationSearchType

)

Gets the default filters to apply when searching for locations and the search is for the specific purpose.

GetDefaultSort() [1/3]

string TRIM.SDK.SortAndFilterUserOptions.GetDefaultSort

(

BaseObjectTypes

forObjectType

)

Gets the default sort order when searching for objects of the specified type and there is no specific purpose specified.

GetDefaultSort() [2/3]

string TRIM.SDK.SortAndFilterUserOptions.GetDefaultSort	(	BaseObjectTypes	forObjectType,
		int	forSpecialPurpose
	)

Gets the default sort order when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific sort setting.

GetDefaultSort() [3/3]

string TRIM.SDK.SortAndFilterUserOptions.GetDefaultSort

(

LocationPurpose

forLocationSearchType

)

Gets the default sort order when searching for locations and the search is for the specific purpose.

SetDefaultFilters() [1/3]

void TRIM.SDK.SortAndFilterUserOptions.SetDefaultFilters	(	BaseObjectTypes	forObjectType,
		int	forSpecialPurpose,
		string	newFilters
	)

Sets the default filters to apply when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific sort setting.

SetDefaultFilters() [2/3]

void TRIM.SDK.SortAndFilterUserOptions.SetDefaultFilters	(	BaseObjectTypes	forObjectType,
		string	newFilters
	)

Sets the default filters to apply when searching for objects of the specified type. For locations, use the option to specify the defaults for the specific location purpose instead.

SetDefaultFilters() [3/3]

void TRIM.SDK.SortAndFilterUserOptions.SetDefaultFilters	(	LocationPurpose	forLocationSearchType,
		string	newFilters
	)

Sets the default filters to apply when searching for locations and the search is for the specific purpose.

SetDefaultSort() [1/3]

void TRIM.SDK.SortAndFilterUserOptions.SetDefaultSort	(	BaseObjectTypes	forObjectType,
		int	forSpecialPurpose,
		string	newSortSpecification
	)

Sets the default sort order when searching for objects of the specified type and the search is for a specific purpose. Note that in only a very few cases (e.g. locations, record types for record creation) does the purpose have a specific sort setting.

SetDefaultSort() [2/3]

void TRIM.SDK.SortAndFilterUserOptions.SetDefaultSort	(	BaseObjectTypes	forObjectType,
		string	newSortSpecification
	)

Sets the default sort order when searching for objects of the specified type and there is no specific purpose specified.

SetDefaultSort() [3/3]

void TRIM.SDK.SortAndFilterUserOptions.SetDefaultSort	(	LocationPurpose	forLocationSearchType,
		string	newSortSpecification
	)

Sets the default sort order when searching for locations and the search is for the specific purpose.