SearchTerm

The SEARCHTERM data type contains information that can be used to perform an initial search on the destination’s application.  For example, a requester might wish to view a supplier’s catalog but restrict the result set for only ‘ballpoint pens’.  The requester would use this data type to perform this initial query.

See http://www.openapplications.org/oagis/9.

Element information

Content

• Sequence [1..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
  2. InclusiveIndicator [0..1]    The SearchValueInclusiveInd 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'
  3. 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.
  4. 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
  5. 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.
  6. UserArea [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.

Attributes

None

Used in

• Type OnlineSessionType (Element OnlineSession)

Sample instance

<SearchTerm>
   <SearchValueText>string</SearchValueText>
   <InclusiveIndicator>true</InclusiveIndicator>
   <ExactMatchIndicator>true</ExactMatchIndicator>
   <Operator>token</Operator>
   <SearchQualifier>token</SearchQualifier>
   <UserArea>
      <!--any element-->
   </UserArea>
</SearchTerm>