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

Recommended Reading:

Definitive XML Schema

 

Advanced XML Applications

 

ulex:SearchRequestMetadataType

A data type for information that further qualifies a search request.

Complex type information

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

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

Content

  • Sequence [1..1]
      from subst. group ulex:RequestedDataAbstract
    1. lexs:RequestedDataCategoryCode [1..*]A kind of requested Data Category.
      2. from subst. group ulex:DataOwnerIdentifierAbstract
    2. lexs:DataOwnerIdentifier [0..*]A unique identifier for an organization and a system in an organization that owns data. This identifier is used in DataOwnerMetadata that is part of PackageMetadata, and in DataOwnerInformation that is part of DataOwnersResponseMessage.
    3. ulex:MaxItemMatchesNumeric [1..1]A maximum number of hits the user (or application acting on behalf of the user) wants back in a response. Note that the service provider may override this value if the service provider's limit is less than the number requested.
    4. ulex:MatchBeginAfterText [0..1]A value used by a service provider on a next/previous query to determine where the next set of hits should start. It is populated with the value of MatchEndPointText from the response the user is following up. Value is of string type to give service provider as much flexibility as possible for point data format.
    5. ulex:MatchEndBeforeText [0..1]A value used by a service provider on a next/previous query to determine where the previous set of hits should end. It is populated with the value of MatchBeginPointText from the response the user if following up. Value is of string type to give service provider as much flexibility as possible for point data format.
    6. 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.
    7. ulex:DataItemCategoryText [0..*]A kind of Data Item category such as type of the event or a data type. This should be a user-friendly and reasonably intuitive string that can be used in a list or as a check-box label in a GUI. Used as a search parameter in SearchRequestMetadata.
      8. from subst. group ulex:SortOrderAbstract
    8. lexs:SortOrderCode [0..1]A sort order code that indicates to the service provider what set of hits, most recent or most relevant, should be returned if there are more hits than can be returned in a single response. The responding system determines what is most relevant.
    9. ulex:TimeoutDuration [0..1]A time in seconds within which the requesting system would like to receive a response. This element would primarily be used to convey a time period past which a response would not be useable by the requesting system. The time period specified excludes time for connection overhead to avoid the need for time synchronization between systems and thus should be slightly shorter than the period needed by the requesting system. The server, if capable of supporting such functionality, should cancel the search and return a timeout advisory response within the time limit specified. It is suggested that the search query should be timed out by the server prior to the time limit specified in order to allow time for canceling the query and returning a response before the period expires.
    10. ulex:NumberOfStructuredPayloadTerms [0..*]A number of search terms used in a query for a given Structured Payload. Structures provides a count of search terms in any included Structured Payload elements so that service providers that do not understand one or more Structured Payloads will have a count of terms that were ignored for the purposes of calculating an accurate MatchScore. This element indicates the Structured Payload to which it applies and provides the number of search terms in that Structured Payload section.
    11. Choice [1..1]
        from subst. group ulex:StructuredPayloadsRequestedAbstract
      • ulex:StructuredPayloadsRequestedCodeA code that indicates whether responses should include all available Structured Payloads or no Structured Payloads. "All" indicates that the requesting system would like to receive any Structured Payloads that the service provider can return. "None" indicates that the requesting system does not want any Structured Payloads.
      • ulex:StructuredPayloadsRequestedListA list of requested Structured Payloads. If this list element is provided instead of the code element, it means that the requesting system does not want to receive responses with any Structured Payloads except for the ones specified.
      12. from subst. group ulex:SearchRequestMetadataExtensionAbstract
    12. ulex:SearchRequestMetadataDomainAttribute [0..*]A search request 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