HPE Content Manager SDK 9.1
|
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...
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... | |
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... | |
Public Member Functions inherited from HP.HPTRIM.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 | GetSearchClauseIdsForGroup (BaseObjectTypes forObjectType, SearchClauseGroup withinGroup, Database withinDatabase) |
Constructs an array of SearchClauseIds for the nominated object type and within the specified group. 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. 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 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... | |
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.
HP.HPTRIM.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.
bool HP.HPTRIM.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.
|
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.
|
static |
Constructs an array of all SearchClauseIds for the nominated object type.
AllEnumerations HP.HPTRIM.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.
BaseObjectTypes HP.HPTRIM.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.
string HP.HPTRIM.SDK.SearchClauseDef.GetParametersTooltip | ( | BaseObjectTypes | whenUsedForObjectType | ) |
Gets a string containing a tool tip about the parameters required for this search clause.
|
static |
Constructs an array of SearchClauseIds for the nominated object type and within the specified group.
string HP.HPTRIM.SDK.SearchClauseDef.GetSortTooltip | ( | BaseObjectTypes | whenUsedForObjectType | ) |
Gets a string containing a tool tip when using this search clause for sorting.
string HP.HPTRIM.SDK.SearchClauseDef.GetTooltip | ( | BaseObjectTypes | whenUsedForObjectType | ) |
Gets a string containing a tool tip for this search clause.
bool HP.HPTRIM.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.
bool HP.HPTRIM.SDK.SearchClauseDef.IsRelevantForType | ( | BaseObjectTypes | trimObjectType | ) |
Gets a boolean value indicating whether this search clause is relevant for the nominated type of TRIM object.
|
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.
|
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.
|
get |
Gets the identifier of the TRIM icon associated with this search clause.
|
get |
Gets an integer containing the unique search clause identifier for this search clause definition.
|
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.
|
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.
|
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
|
get |
Gets a boolean value indicating whether this search clause needs the additional AccessControlType parameter.
|
get |
Gets a boolean value indicating whether this search clause needs the additional SubQueryRelationshipType parameter.
|
get |
Gets a boolean value indicating whether this search clause needs the additional SubQueryObjectType parameter.
|
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.
|
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.