SearchTermBaseType
Complex type information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Properties: ID: oagis-id-3933d5659bba44c89935ae5f9d83b64a
Content
- Sequence [1..1]
- SearchValueText [0..1] The SearchValue is the element that identifies the search value the catalog provider (destination system or context) should query for. As in the previous example, if the user wishes to query for a result set of only ballpoint pens, the SearchValue for this might be ‘Ballpoint.’ The catalog provider will then take this SearchValue and query for this match. The Show URL transaction would then redirect the originating system to a URL that contains this result set
- InclusiveIndicator [0..1] The InclusiveIndicator element is used to identify whether the SearchValue should be an included or excluded component of the result set. For example, if a user was looking for ballpoint pens, but NOT red ballpoint pens, the transaction would contain two instances of the SearchTerm data type one containing a SearchValue of ‘Ballpoint’ and an SearchValueInclusive of 'Inclusive' and one containing a SearchValue of ‘Red’ and an SearchValueInclusive of 'Exclusive'
- ExactMatchIndicator [0..1] The ExactMatch element is used to define the type of search the external system should perform. If the ExactMatch is true then the external system should (if supported) search using this criterion and return only the data that exactly matches the search criteria. A false value would mean that the external system should use this search criterion and return a ‘fuzzy’ match of data that contains the search criteria but not necessarily an explicit match.
- Operator [0..1] The Operator element defines operator criteria for the SearchValue. For instance if the requester wishes to return a result set of all prices > $600, the transaction would contain a SearchTerm data type with a SearchValue of ‘600’, an SearchValueInclusive of ‘0’ and an OPERATOR value of ‘>.’ The valid values for OPERATOR are: "Greater Then, Less Then, Greater Then or Equals, Less Then or Equals, Equals
- SearchQualifier [0..1] The SearchQualifier element is an additional element to identify how the SearchValue should be utilized for the search in the catalog provider’s system. The SearchQualifier could be used to indicate that the SearchValue should be searched for in Item Descriptions, or categories, etc.
from type IdentificationType
Attributes
Name | Occ | Type | Description | Notes |
---|---|---|---|---|
typeCode | [0..1] | CodeType_1E7368 | from type IdentificationType | |
actionCode | [0..1] | ActionCodeContentType | from type IdentificationType |
Used by
- Element SearchTerm via derived type SearchTermType
Type inheritance chain
- IdentificationType
- SearchTermBaseType
- extended by SearchTermType
- SearchTermBaseType