Schema Central  >  LEXS 4.0  >  ulex.xsd  >  ulex:SearchResponseMetadata
Advanced search
Need NIEM Help?

Recommended Reading:

Definitive XML Schema

 

Advanced XML Applications

 

ulex:SearchResponseMetadata

Metadata about a search response.

Element information

Namespace: http://ulex.gov/ulex/2.0

Schema document: ulex.gov/ulex/2.0/ulex.xsd

Type: ulex:SearchResponseMetadataType

Properties: Global, Qualified

Content

  • Sequence [1..1]
    1. ulex:MaxItemMatchesRequestedNumeric [1..1]A maximum number of hits the user (or application acting on behalf of the user) requested.
    2. ulex:NumberItemMatchesText [1..1]A number of matches found, as opposed to returned, by the service provider. Text field that can contain a number or an indication that there were more than a certain number of hits, such as 100+.
    3. ulex:ServerLimitIndicator [1..1]True if the number of hits was restricted due to a service provider limit (the number returned was limited due to a server restriction); false otherwise.
    4. ulex:MatchBeginPointText [0..1]A value used by a service provider on a next/previous query to indicate the starting point for the set of data that is being returned. Value is of string type to give service provider as much flexibility as possible for point data format.
    5. ulex:MatchEndPointText [0..1]A value used by a service provider on a next/previous query to indicate the ending point for the set of data that is being returned. Value is of string type to give service provider as much flexibility as possible for point data format.
    6. ulex:PerformedStructuredQuery [0..1]A ULEX Structured query, stated using the ULEX Digest and Structured Payload entities by supplying field values for selected elements. Structured query that was performed by the service provider and may differ from the query that was requested by the client.
    7. ulex:RequestedStructuredQuery [0..1]A ULEX Structured query, stated using the ULEX Digest and Structured Payload entities by supplying field values for selected elements. Structured query that was requested by the client, which may differ from the query that was performed by the service provider.
    8. ulex:ServiceProviderSearchID [0..1]An identifier for a search that is meaningful to the service provider for returning additional hits. This allows the service provider to utilize any state information it may retain so that it does not have to rerun the query again to get the next or previous set of results. Service providers define this value; requesters merely copy the value back into the follow-up query.
    9. ulex:SearchResponseMetadataDomainAttribute [0..*]A search response metadata domain attribute. For name/value pair attributes use ulex:AttributeName and ulex:AttributeValueText elements. For hierarchical data xsd:any structure should be used.

Attributes

None

Used in

Sample instance

<ulex:SearchResponseMetadata>
   <ulex:MaxItemMatchesRequestedNumeric>10</ulex:MaxItemMatchesRequestedNumeric>
   <ulex:NumberItemMatchesText>2</ulex:NumberItemMatchesText>
   <ulex:ServerLimitIndicator>false</ulex:ServerLimitIndicator>
</ulex:SearchResponseMetadata>