GetSearchableProperties Method
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
Creates a data set that describes the searchable entities in the system and for each object, the searchable properties for that object.
Namespace: Microsoft.CommerceServer.Marketing
Assembly: Microsoft.CommerceServer.Marketing.CrossTierTypes (in Microsoft.CommerceServer.Marketing.CrossTierTypes.dll)
Syntax
'Declaration
Public Function GetSearchableProperties As DataSet
'Usage
Dim instance As MarketingContext
Dim returnValue As DataSet
returnValue = instance.GetSearchableProperties()
public DataSet GetSearchableProperties()
public:
DataSet^ GetSearchableProperties()
public function GetSearchableProperties() : DataSet
Return Value
Type: System.Data..::.DataSet
A DataSet describing the searchable entities in the Marketing System. See the remarks section for details on the format of this DataSet.
Remarks
The returned DataSet contains a DataTable called SearchableEntities and a DataTable for each entity that is searchable and a DataTable for each enumeration. The SearchableEntities DataTable contains the following columns:
Column Name |
Value |
|---|---|
EntityName |
The programmatic name of the entity that should be used when constructing a SearchClause to search the entity. |
For each searchable entity type, there is a corresponding DataTable. The name of the DataTable is the name of the entity (not the DisplayName). This DataTable contains the following columns:
Column Name |
Value |
|---|---|
PropertyName |
The name of the property. |
PropertyType |
The type of the property as a string. The types are "String", "Money", "DateTime", "Boolean", "Integer", and enumeration types. For enumeration types, the type name is the type of the enumeration, which ends in the suffix "Enum". For each enumeration type, there is also another DataTable present in the SearchableEntities DataSet containing the values for the enumeration. |
IsSearchable |
true if the property can be used as part of the criteria in a SearchClause; otherwise false. |
IsReturnable |
true if the property can be specified in the PropertiesToReturn list of a SearchOptions object, otherwise false. |
IsReturnedByDefault |
true if the property is returned by default when no PropertiesToReturn are explicitly specified, otherwise false. |
For each enumeration type, there is a corresponding DataTable. The name of the DataTable is the name of the enumeration type (not the DisplayName). This DataTable contains the following columns:
Column Name |
Value |
|---|---|
EnumValue |
The name of the enumeration value. |
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.