Inheritance diagram for HP.HPTRIM.SDK.SearchClauseOrFieldDef:

Public Member Functions
	SearchClauseOrFieldDef ()
	Construct a SearchClauseOrFieldDef that encapsulates a standard search clause definition. More...

	SearchClauseOrFieldDef (SearchClauseIds clauseId)
	Construct a SearchClauseOrFieldDef that encapsulates a standard search clause definition. The database parameter allows the item access to any customized captions. More...

	SearchClauseOrFieldDef (SearchClauseIds propId, Database forDatabase)
	Construct a SearchClauseOrFieldDef that encapsulates a standard search clause definition. More...

	SearchClauseOrFieldDef (SearchClauseDef clauseDef)
	Construct a SearchClauseOrFieldDef that encapsulates a FieldDefinition object. More...

	SearchClauseOrFieldDef (FieldDefinition Field)

bool	IsAvailableForType (BaseObjectTypes trimObjectType)
	Gets a boolean value indicating whether this search method 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 method 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...

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...

Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Static Public Member Functions
static int	Compare (SearchClauseOrFieldDef itemToTest1, SearchClauseOrFieldDef itemToTest2)
	Compares two ApiSearchClauseOrFieldDef objects, using the caption as a sort sequence More...

static SearchClauseOrFieldDefList	GetAllSearchClausesOrFields (Database withinDatabase, BaseObjectTypes forObjectType)
	Gets an array of ApiSearchClauseOrFieldDef objects consisting of all standard search clause definitions for the specified object type, followed by all the searchable user defined fields for the specified object type. More...

static SearchClauseOrFieldDefList	GetAllSearchClausesOrFields (TrimObject forObject)
	Gets an array of ApiSearchClauseOrFieldDef objects consisting of all standard search clause definitions for the specified TrimObject, followed by all the searchable user defined fields for the specified TrimObject. More...

static SearchClauseOrFieldDefList	GetFavoriteSearchClausesOrFields (Database withinDatabase, BaseObjectTypes forObjectType)
	Gets an array of ApiSearchClauseOrFieldDef objects consisting of the current users selected favorite search methods for the specified object type. More...

static SearchClauseOrFieldDefList	GetFavoriteSearchClausesOrFields (TrimObject forObject)
	Gets an array of ApiSearchClauseOrFieldDef objects consisting of the current users selected favorite search methods for the specified object. More...

static SearchClauseOrFieldDefList	GetRecentSearchClausesOrFields (Database withinDatabase, BaseObjectTypes forObjectType)
	Gets an array of ApiSearchClauseOrFieldDef objects consisting of all current users most recently used search methods for the specified object type. More...

static SearchClauseOrFieldDefList	GetRecentSearchClausesOrFields (TrimObject forObject)
	Gets an array of ApiSearchClauseOrFieldDef objects consisting of all current users most recently used search methods for the specified object. More...

static void	SetFavoriteSearchClausesOrFields (TrimObject forObject, SearchClauseOrFieldDefList searchMethodArray)
	Sets an array of ApiSearchClauseOrFieldDef objects as the list of favorite search methods for the current user and object. More...

static void	SetFavoriteSearchClausesOrFields (Database withinDatabase, BaseObjectTypes forObjectType, SearchClauseOrFieldDefList searchMethodArray)
	Sets an array of ApiSearchClauseOrFieldDef objects as the list of favorite search methods for the current user and object type. More...

static void	SetRecentSearchClausesOrFields (TrimObject forObject, SearchClauseOrFieldDefList searchMethodArray)
	Sets an array of ApiSearchClauseOrFieldDef objects as the list of recent search methods for the current user and object. More...

static void	SetRecentSearchClausesOrFields (Database withinDatabase, BaseObjectTypes forObjectType, SearchClauseOrFieldDefList searchMethodArray)
	Sets an array of ApiSearchClauseOrFieldDef objects as the list of recent search methods for the current user and object type. More...

Properties
bool	IsASearchClause `[get]`
	Gets a boolean value indicating whether this object represents a standard search clause definition (as opposed to a field). More...

bool	IsAField `[get]`
	Gets a Boolean value indicating whether this object represents a user field (as opposed to a standard search clause definition). More...

SearchClauseIds	ClauseId `[get]`
	Gets a SearchClauseIds enumeration value containing the SearchClauseId associated with this object, if it is a standard search clause definition. More...

SearchClauseDef	ClauseDef `[get]`
	Gets the SearchClauseDef object associated with this SearchClauseOrFieldDef, if it is a standard search clause definition. More...

TrimURI	FieldUri `[get]`
	Gets the unique identifier of the FieldDefinition associated with this object, if it is a user field. More...

FieldDefinition	Field `[get]`
	Gets or sets the FieldDefinition object associated with this SearchClauseOrFieldDef, it if is a user field More...

SearchParameterFormats	SearchParameterFormat `[get]`
	Gets a SearchParameterFormats enum value indicating the generic format of this search method . More...

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

string	ClauseName `[get]`
	Gets a short format search method name that can be used in the string searching syntax More...

string	Caption `[get]`
	Gets the caption corresponding to this property or field. More...

Properties inherited from HP.HPTRIM.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...

Constructor & Destructor Documentation

HP.HPTRIM.SDK.SearchClauseOrFieldDef.SearchClauseOrFieldDef ( )

Construct a SearchClauseOrFieldDef that encapsulates a standard search clause definition.

HP.HPTRIM.SDK.SearchClauseOrFieldDef.SearchClauseOrFieldDef ( SearchClauseIds clauseId )

Construct a SearchClauseOrFieldDef that encapsulates a standard search clause definition. The database parameter allows the item access to any customized captions.

HP.HPTRIM.SDK.SearchClauseOrFieldDef.SearchClauseOrFieldDef	(	SearchClauseIds	propId,
		Database	forDatabase
	)

Construct a SearchClauseOrFieldDef that encapsulates a standard search clause definition.

HP.HPTRIM.SDK.SearchClauseOrFieldDef.SearchClauseOrFieldDef ( SearchClauseDef clauseDef )

Construct a SearchClauseOrFieldDef that encapsulates a FieldDefinition object.

HP.HPTRIM.SDK.SearchClauseOrFieldDef.SearchClauseOrFieldDef ( FieldDefinition Field )

Member Function Documentation

bool HP.HPTRIM.SDK.SearchClauseOrFieldDef.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.

static int HP.HPTRIM.SDK.SearchClauseOrFieldDef.Compare	(	SearchClauseOrFieldDef	itemToTest1,
		SearchClauseOrFieldDef	itemToTest2
	)

static

Compares two ApiSearchClauseOrFieldDef objects, using the caption as a sort sequence

static SearchClauseOrFieldDefList HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetAllSearchClausesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType
	)

static

Gets an array of ApiSearchClauseOrFieldDef objects consisting of all standard search clause definitions for the specified object type, followed by all the searchable user defined fields for the specified object type.

static SearchClauseOrFieldDefList HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetAllSearchClausesOrFields ( TrimObject forObject )

static

Gets an array of ApiSearchClauseOrFieldDef objects consisting of all standard search clause definitions for the specified TrimObject, followed by all the searchable user defined fields for the specified TrimObject.

static SearchClauseOrFieldDefList HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetFavoriteSearchClausesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType
	)

static

Gets an array of ApiSearchClauseOrFieldDef objects consisting of the current users selected favorite search methods for the specified object type.

static SearchClauseOrFieldDefList HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetFavoriteSearchClausesOrFields ( TrimObject forObject )

static

Gets an array of ApiSearchClauseOrFieldDef objects consisting of the current users selected favorite search methods for the specified object.

string HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetParametersTooltip ( BaseObjectTypes whenUsedForObjectType )

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

static SearchClauseOrFieldDefList HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetRecentSearchClausesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType
	)

static

Gets an array of ApiSearchClauseOrFieldDef objects consisting of all current users most recently used search methods for the specified object type.

static SearchClauseOrFieldDefList HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetRecentSearchClausesOrFields ( TrimObject forObject )

static

Gets an array of ApiSearchClauseOrFieldDef objects consisting of all current users most recently used search methods for the specified object.

string HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetSortTooltip ( BaseObjectTypes whenUsedForObjectType )

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

string HP.HPTRIM.SDK.SearchClauseOrFieldDef.GetTooltip ( BaseObjectTypes whenUsedForObjectType )

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

bool HP.HPTRIM.SDK.SearchClauseOrFieldDef.IsActivatedForType ( BaseObjectTypes trimObjectType )

Gets a boolean value indicating whether this search method 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.

bool HP.HPTRIM.SDK.SearchClauseOrFieldDef.IsAvailableForType ( BaseObjectTypes trimObjectType )

Gets a boolean value indicating whether this search method 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.

static void HP.HPTRIM.SDK.SearchClauseOrFieldDef.SetFavoriteSearchClausesOrFields	(	TrimObject	forObject,
		SearchClauseOrFieldDefList	searchMethodArray
	)

static

Sets an array of ApiSearchClauseOrFieldDef objects as the list of favorite search methods for the current user and object.

static void HP.HPTRIM.SDK.SearchClauseOrFieldDef.SetFavoriteSearchClausesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType,
		SearchClauseOrFieldDefList	searchMethodArray
	)

static

Sets an array of ApiSearchClauseOrFieldDef objects as the list of favorite search methods for the current user and object type.

static void HP.HPTRIM.SDK.SearchClauseOrFieldDef.SetRecentSearchClausesOrFields	(	TrimObject	forObject,
		SearchClauseOrFieldDefList	searchMethodArray
	)

static

Sets an array of ApiSearchClauseOrFieldDef objects as the list of recent search methods for the current user and object.

static void HP.HPTRIM.SDK.SearchClauseOrFieldDef.SetRecentSearchClausesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType,
		SearchClauseOrFieldDefList	searchMethodArray
	)

static

Sets an array of ApiSearchClauseOrFieldDef objects as the list of recent search methods for the current user and object type.

Property Documentation

string HP.HPTRIM.SDK.SearchClauseOrFieldDef.Caption

get

Gets the caption corresponding to this property or field.

SearchClauseDef HP.HPTRIM.SDK.SearchClauseOrFieldDef.ClauseDef

get

Gets the SearchClauseDef object associated with this SearchClauseOrFieldDef, if it is a standard search clause definition.

SearchClauseIds HP.HPTRIM.SDK.SearchClauseOrFieldDef.ClauseId

get

Gets a SearchClauseIds enumeration value containing the SearchClauseId associated with this object, if it is a standard search clause definition.

string HP.HPTRIM.SDK.SearchClauseOrFieldDef.ClauseName

get

Gets a short format search method name that can be used in the string searching syntax

FieldDefinition HP.HPTRIM.SDK.SearchClauseOrFieldDef.Field

get

Gets or sets the FieldDefinition object associated with this SearchClauseOrFieldDef, it if is a user field

TrimURI HP.HPTRIM.SDK.SearchClauseOrFieldDef.FieldUri

get

Gets the unique identifier of the FieldDefinition associated with this object, if it is a user field.

bool HP.HPTRIM.SDK.SearchClauseOrFieldDef.IsAField

get

Gets a Boolean value indicating whether this object represents a user field (as opposed to a standard search clause definition).

bool HP.HPTRIM.SDK.SearchClauseOrFieldDef.IsASearchClause

get

Gets a boolean value indicating whether this object represents a standard search clause definition (as opposed to a field).

SearchClauseGroup HP.HPTRIM.SDK.SearchClauseOrFieldDef.MethodGroup

get

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

SearchParameterFormats HP.HPTRIM.SDK.SearchClauseOrFieldDef.SearchParameterFormat

get

Gets a SearchParameterFormats enum value indicating the generic format of this search method .

Public Member Functions

Static Public Member Functions

Properties

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation