Client Declaration
public GetSearchMetadataResponse GetSearchMetadata(GetSearchMetadataRequest GetSearchMetadataRequest)
This operation is a companion to the ExecuteSearch
operation,
and provides the metadata (class and property descriptions) for a particular search scope.
A GetSearchMetadata
response is similar to a response by a GetObjects
request that specifies the ClassDescriptions
property (a set collection of ClassDescription
objects) of an object store. However, unlike a GetObjects
response, only those ClassDescription
objects that describe classes that are searchable in the specified search scope and are allowed by the class filter are included.
The PropertyDescriptions
and ProperSubclassPropertyDescriptions
object collections returned for any ClassDescription
objects in the ClassDescriptions
collection include only property descriptions of properties that are relevant to the query (that is queryable, selectable or orderable).
A GetSearchMetadataRequest
element, which specifies the following:
SearchScopeType
element, which specifies the scope of object stores to search.A typical structure of a GetSearchMetadata
request is as follows. Elements that are derived from their base element are in parenthesis:
GetSearchMetadataRequest
GetSearchMetadataRequest (MergedScope
)SearchScopeType
SearchScope (ObjectStoreScope
)SearchScopeType
ComponentScope[0] (MergedScope
)SearchScopeType
ComponentScope[1] (ObjectStoreScope
)SearchScopeType
ComponentScope[0] (MergedScope
)SearchScopeType
ComponentScope[1] . .PropertyFilterType
PropertyFilterFilterElementType
IncludeProperties[0]FilterElementType
IncludeProperties[1] . .FilterElementType
IncludeTypes[0]FilterElementType
IncludeTypes[1] . .
GetSearchMetadata
has the following output, depending on whether it is successful or not:
GetSearchMetadataResponse
element, which specifies the following:
CollectionTerminatorType
base element, which resolves to one the following elements, depending on the navigation status within the object set collection:
EndOfCollection
: The last result row is included in this response.EndOfPage
: The object set contains the maximum number of object elements (page size) requested by the client.TraversalError
: A error has occurred in traversing the object set.ObjectValue
elements, each of which represents an object selected by the query. Each element specifies the following:
ErrorStackType
element is returned.A typical structure of a GetSearchMetadata
response is as follows. Elements that are derived from their base element are in parenthesis:
GetSearchMetadataResponse
GetSearchMetadataResponse (EndofPage
)CollectionTerminatorType
CollectionTerminatorObjectValue
Object[0] (SingletonString
)PropertyType
Property[0] (SingletonInteger32
)PropertyType
Property[1] . .ObjectValue
Object[1] . .
<operation name="GetSearchMetadata"> <input message="tns:GetSearchMetadataRequest"/> <output message="tns:GetSearchMetadataResponse"/> <fault message="tns:FaultResponse" name="GeneralError"/> </operation>