A helper class that allows you to determine generic capabilities of any of the search clauses defined for selecting TRIM objects in the TRIM object model. More...

Inheritance diagram for TRIM.SDK.SearchClauseDef:

Public Member Functions
	SearchClauseDef (SearchClauseIds idValue, Database forDatabase)
	Constructs an SearchClauseDef object based on the specified SearchClauseIds enumeration value. This form of constructor allows you to specify a database which is used to retrieve customised captions. More...

string	GetTooltip (BaseObjectTypes whenUsedForObjectType)
	Gets a string containing a tool tip for this search clause. More...

string	GetParametersTooltip (BaseObjectTypes whenUsedForObjectType)
	Gets a string containing a tool tip about the parameters required for this search clause. More...

bool	CanSort (BaseObjectTypes whenUsedForObjectType)
	Gets a boolean value indicating whether this search clause can be used a sort criteria for searching for the specified object type. More...

string	GetSortTooltip (BaseObjectTypes whenUsedForObjectType)
	Gets a string containing a tool tip when using this search clause for sorting. More...

bool	IsRelevantForType (BaseObjectTypes trimObjectType)
	Gets a boolean value indicating whether this search clause is relevant for the nominated type of TRIM object. More...

bool	IsAvailableForType (BaseObjectTypes trimObjectType)
	Gets a boolean value indicating whether this search clause is available for the nominated type of TRIM object. If the function returns false, the ErrorMessage property will contain an informational message indicating why the search method is unavailable. More...

bool	IsActivatedForType (BaseObjectTypes trimObjectType)
	Gets a boolean value indicating whether this search clause is available for the nominated type of TRIM object. It also checks if it is linked to a product feature and whether that product feature is activated. If the function returns false, the ErrorMessage property will contain an informational message indicating why the search method is unavailable. More...

BaseObjectTypes	GetObjectTypeParameter (BaseObjectTypes whenSearchingForObjectOfType)
	Gets a BaseObjectTypes enumeration value indicating the type of object that needs to be supplied as a data value when search by this search clause. Is only relevant when the ParameterFormat is of type Object. More...

AllEnumerations	GetEnumTypeParameter ()
	Gets an AllEnumerations enumeration value indicating the TRIM enum that is associated with a search is being made by this search clause. Is only relevant when the ParameterFormat is of type Enum. More...

bool	IsBlocked (BaseObjectTypes whenSearchingForObjectOfType)
	Gets a boolean value indicating whether this search clause has been blocked by the administrator for the current user More...

Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Static Public Member Functions
static SearchClauseIds	FindSearchClauseIdFromString (string searchString, BaseObjectTypes whenSearchingForObjectOfType, Database forDatabase)
	Gets an SearchClauseIds enumeration value from a search string name. Returns Unknown if there is no matching search clause available for the nominated TRIM object type. This form also allows you to supply a Database in order that any customised search strings will be examined. More...

static SearchClauseIdsList	GetAllSearchClauseIds (BaseObjectTypes forObjectType, Database withinDatabase)
	Constructs an array of all SearchClauseIds for the nominated object type. More...

static SearchClauseIdsList	GetAllSearchClauseIds (BaseObjectTypes forObjectType, Database withinDatabase, bool excludeBlockedClauses)
	Constructs an array of all SearchClauseIds for the nominated object type, providing an option to exclude methods that have been blocked for the current user More...

static SearchClauseIdsList	GetSearchClauseIdsForGroup (BaseObjectTypes forObjectType, SearchClauseGroup withinGroup, Database withinDatabase)
	Constructs an array of SearchClauseIds for the nominated object type and within the specified group. More...

static SearchClauseIdsList	GetSearchClauseIdsForGroup (BaseObjectTypes forObjectType, SearchClauseGroup withinGroup, Database withinDatabase, bool excludeBlockedClauses)
	Constructs an array of SearchClauseIds for the nominated object type and within the specified group, providing an option to exclude methods that have been blocked for the current user More...

Properties
SearchClauseIds	Id `[get]`
	Gets an integer containing the unique search clause identifier for this search clause definition. More...

string	Name `[get, set]`
	Gets or sets a string containing the name for this search clause. The name is used when constructing a search string containing one or more search clauses. Note that to set a name, this search clause must have been constructed with a valid Database parameter. To make name changes permanent, call the SaveCaptionChanges method of the database More...

Icons	Icon `[get]`
	Gets the identifier of the TRIM icon associated with this search clause. More...

string	InternalName `[get]`
	Gets a string containing the internal name for this search clause. It will be the same as the Name property unless there has been a customisation done for this database. More...

string	Caption `[get, set]`
	Gets or sets a caption for this search clause. This is usually the caption for the associated property, where the clause is based on that property. In other cases, this is a short but more user friendly name for the search clause. More...

BaseObjectTypes	OnlyForType `[get]`
	Gets a BaseObjectTypes enumeration value indicating the specific object type this search clause belongs to. If the search clause is a generic one (i.e. it applies to more than one object type), a value of Unknown will be returned. More...

PropertyIds	BasedOnProperty `[get]`
	Gets a PropertyIds enumeration value indicating the object property that is associated with this search clause. Many search clauses are simply based on selecting a value for a particular property, some are not specifically associated with a property (in which case the Unknown value will be returned. More...

SearchClauseGroup	MethodGroup `[get]`
	Gets a SearchClauseGroup enumeration value indicating the particlar group of search clauses that this clause belongs to. Search clauses grouped in this way to aid in presentation, in some cases. More...

PropertyFormats	ParameterFormat `[get]`
	Gets a PropertyFormats enumeration value indicating the format of the data value that needs to be provided when using this search clause for searching. (Note. This property will soon be obsolete, use the SearchParameterFormat instead). More...

SearchParameterFormats	SearchParameterFormat `[get]`
	Gets a SearchParameterFormats enumeration value indicating the format of the data value that needs to be provided when using this search clause for searching. More...

bool	NeedsAccessControlTypeParameter `[get]`
	Gets a boolean value indicating whether this search clause needs the additional AccessControlType parameter. More...

bool	NeedsSubQueryObjectTypeParameter `[get]`
	Gets a boolean value indicating whether this search clause needs the additional SubQueryObjectType parameter. More...

bool	NeedsRelationshipTypeParameter `[get]`
	Gets a boolean value indicating whether this search clause needs the additional SubQueryRelationshipType parameter. More...

Properties inherited from TRIM.SDK.TrimSDKObject
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...

Detailed Description

A helper class that allows you to determine generic capabilities of any of the search clauses defined for selecting TRIM objects in the TRIM object model.

Constructor & Destructor Documentation

◆ SearchClauseDef()

TRIM.SDK.SearchClauseDef.SearchClauseDef	(	SearchClauseIds	idValue,
		Database	forDatabase
	)

Constructs an SearchClauseDef object based on the specified SearchClauseIds enumeration value. This form of constructor allows you to specify a database which is used to retrieve customised captions.

Member Function Documentation

◆ CanSort()

bool TRIM.SDK.SearchClauseDef.CanSort ( BaseObjectTypes whenUsedForObjectType )

Gets a boolean value indicating whether this search clause can be used a sort criteria for searching for the specified object type.

◆ FindSearchClauseIdFromString()

static SearchClauseIds TRIM.SDK.SearchClauseDef.FindSearchClauseIdFromString	(	string	searchString,
		BaseObjectTypes	whenSearchingForObjectOfType,
		Database	forDatabase
	)

static

Gets an SearchClauseIds enumeration value from a search string name. Returns Unknown if there is no matching search clause available for the nominated TRIM object type. This form also allows you to supply a Database in order that any customised search strings will be examined.

◆ GetAllSearchClauseIds() [1/2]

static SearchClauseIdsList TRIM.SDK.SearchClauseDef.GetAllSearchClauseIds	(	BaseObjectTypes	forObjectType,
		Database	withinDatabase
	)

static

Constructs an array of all SearchClauseIds for the nominated object type.

◆ GetAllSearchClauseIds() [2/2]

static SearchClauseIdsList TRIM.SDK.SearchClauseDef.GetAllSearchClauseIds	(	BaseObjectTypes	forObjectType,
		Database	withinDatabase,
		bool	excludeBlockedClauses
	)

static

Constructs an array of all SearchClauseIds for the nominated object type, providing an option to exclude methods that have been blocked for the current user

◆ GetEnumTypeParameter()

AllEnumerations TRIM.SDK.SearchClauseDef.GetEnumTypeParameter ( )

Gets an AllEnumerations enumeration value indicating the TRIM enum that is associated with a search is being made by this search clause. Is only relevant when the ParameterFormat is of type Enum.

◆ GetObjectTypeParameter()

BaseObjectTypes TRIM.SDK.SearchClauseDef.GetObjectTypeParameter ( BaseObjectTypes whenSearchingForObjectOfType )

Gets a BaseObjectTypes enumeration value indicating the type of object that needs to be supplied as a data value when search by this search clause. Is only relevant when the ParameterFormat is of type Object.

◆ GetParametersTooltip()

string TRIM.SDK.SearchClauseDef.GetParametersTooltip ( BaseObjectTypes whenUsedForObjectType )

Gets a string containing a tool tip about the parameters required for this search clause.

◆ GetSearchClauseIdsForGroup() [1/2]

static SearchClauseIdsList TRIM.SDK.SearchClauseDef.GetSearchClauseIdsForGroup	(	BaseObjectTypes	forObjectType,
		SearchClauseGroup	withinGroup,
		Database	withinDatabase
	)

static

Constructs an array of SearchClauseIds for the nominated object type and within the specified group.

◆ GetSearchClauseIdsForGroup() [2/2]

static SearchClauseIdsList TRIM.SDK.SearchClauseDef.GetSearchClauseIdsForGroup	(	BaseObjectTypes	forObjectType,
		SearchClauseGroup	withinGroup,
		Database	withinDatabase,
		bool	excludeBlockedClauses
	)

static

Constructs an array of SearchClauseIds for the nominated object type and within the specified group, providing an option to exclude methods that have been blocked for the current user

◆ GetSortTooltip()

string TRIM.SDK.SearchClauseDef.GetSortTooltip ( BaseObjectTypes whenUsedForObjectType )

Gets a string containing a tool tip when using this search clause for sorting.

◆ GetTooltip()

string TRIM.SDK.SearchClauseDef.GetTooltip ( BaseObjectTypes whenUsedForObjectType )

Gets a string containing a tool tip for this search clause.

◆ IsActivatedForType()

bool TRIM.SDK.SearchClauseDef.IsActivatedForType ( BaseObjectTypes trimObjectType )

Gets a boolean value indicating whether this search clause is available for the nominated type of TRIM object. It also checks if it is linked to a product feature and whether that product feature is activated. If the function returns false, the ErrorMessage property will contain an informational message indicating why the search method is unavailable.

◆ IsAvailableForType()

bool TRIM.SDK.SearchClauseDef.IsAvailableForType ( BaseObjectTypes trimObjectType )

Gets a boolean value indicating whether this search clause is available for the nominated type of TRIM object. If the function returns false, the ErrorMessage property will contain an informational message indicating why the search method is unavailable.

◆ IsBlocked()

bool TRIM.SDK.SearchClauseDef.IsBlocked ( BaseObjectTypes whenSearchingForObjectOfType )

Gets a boolean value indicating whether this search clause has been blocked by the administrator for the current user

◆ IsRelevantForType()

bool TRIM.SDK.SearchClauseDef.IsRelevantForType ( BaseObjectTypes trimObjectType )

Gets a boolean value indicating whether this search clause is relevant for the nominated type of TRIM object.

Property Documentation

◆ BasedOnProperty

PropertyIds TRIM.SDK.SearchClauseDef.BasedOnProperty

get

Gets a PropertyIds enumeration value indicating the object property that is associated with this search clause. Many search clauses are simply based on selecting a value for a particular property, some are not specifically associated with a property (in which case the Unknown value will be returned.

◆ Caption

string TRIM.SDK.SearchClauseDef.Caption

getset

Gets or sets a caption for this search clause. This is usually the caption for the associated property, where the clause is based on that property. In other cases, this is a short but more user friendly name for the search clause.

◆ Icon

Icons TRIM.SDK.SearchClauseDef.Icon

get

Gets the identifier of the TRIM icon associated with this search clause.

◆ Id

SearchClauseIds TRIM.SDK.SearchClauseDef.Id

get

Gets an integer containing the unique search clause identifier for this search clause definition.

◆ InternalName

string TRIM.SDK.SearchClauseDef.InternalName

get

Gets a string containing the internal name for this search clause. It will be the same as the Name property unless there has been a customisation done for this database.

◆ MethodGroup

SearchClauseGroup TRIM.SDK.SearchClauseDef.MethodGroup

get

Gets a SearchClauseGroup enumeration value indicating the particlar group of search clauses that this clause belongs to. Search clauses grouped in this way to aid in presentation, in some cases.

◆ Name

string TRIM.SDK.SearchClauseDef.Name

getset

Gets or sets a string containing the name for this search clause. The name is used when constructing a search string containing one or more search clauses. Note that to set a name, this search clause must have been constructed with a valid Database parameter. To make name changes permanent, call the SaveCaptionChanges method of the database

◆ NeedsAccessControlTypeParameter

bool TRIM.SDK.SearchClauseDef.NeedsAccessControlTypeParameter

get

Gets a boolean value indicating whether this search clause needs the additional AccessControlType parameter.

◆ NeedsRelationshipTypeParameter

bool TRIM.SDK.SearchClauseDef.NeedsRelationshipTypeParameter

get

Gets a boolean value indicating whether this search clause needs the additional SubQueryRelationshipType parameter.

◆ NeedsSubQueryObjectTypeParameter

bool TRIM.SDK.SearchClauseDef.NeedsSubQueryObjectTypeParameter

get

Gets a boolean value indicating whether this search clause needs the additional SubQueryObjectType parameter.

◆ OnlyForType

BaseObjectTypes TRIM.SDK.SearchClauseDef.OnlyForType

get

Gets a BaseObjectTypes enumeration value indicating the specific object type this search clause belongs to. If the search clause is a generic one (i.e. it applies to more than one object type), a value of Unknown will be returned.

◆ ParameterFormat

PropertyFormats TRIM.SDK.SearchClauseDef.ParameterFormat

get

Gets a PropertyFormats enumeration value indicating the format of the data value that needs to be provided when using this search clause for searching. (Note. This property will soon be obsolete, use the SearchParameterFormat instead).

◆ SearchParameterFormat

SearchParameterFormats TRIM.SDK.SearchClauseDef.SearchParameterFormat

get

Gets a SearchParameterFormats enumeration value indicating the format of the data value that needs to be provided when using this search clause for searching.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SearchClauseDef()

Member Function Documentation

◆ CanSort()

◆ FindSearchClauseIdFromString()

◆ GetAllSearchClauseIds() [1/2]

◆ GetAllSearchClauseIds() [2/2]

◆ GetEnumTypeParameter()

◆ GetObjectTypeParameter()

◆ GetParametersTooltip()

◆ GetSearchClauseIdsForGroup() [1/2]

◆ GetSearchClauseIdsForGroup() [2/2]

◆ GetSortTooltip()

◆ GetTooltip()

◆ IsActivatedForType()

◆ IsAvailableForType()

◆ IsBlocked()

◆ IsRelevantForType()

Property Documentation

◆ BasedOnProperty

◆ Caption

◆ Icon

◆ Id

◆ InternalName

◆ MethodGroup

◆ Name

◆ NeedsAccessControlTypeParameter

◆ NeedsRelationshipTypeParameter

◆ NeedsSubQueryObjectTypeParameter

◆ OnlyForType

◆ ParameterFormat

◆ SearchParameterFormat