Definition Type: ComplexType
Name: SearchTermType
Namespace: http://www.openapplications.org/oagis/9
Containing Schema: OnlineSession.xsd
Abstract
Collapse XSD Schema Diagram:
Drilldown into UserArea in schema fields_xsd Drilldown into SearchQualifier in schema onlinesession_xsd Drilldown into Operator in schema onlinesession_xsd Drilldown into ExactMatchIndicator in schema fields_xsd Drilldown into InclusiveIndicator in schema fields_xsd Drilldown into SearchValueText in schema fields_xsdXSD Diagram of SearchTermType in schema onlinesession_xsd (Open Applications Group (OAGIS))
Collapse XSD Schema Code:
<xsd:complexType name="SearchTermType">
    <xsd:sequence>
        <xsd:element ref="SearchValueText" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="InclusiveIndicator" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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'</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="ExactMatchIndicator" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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.</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="Operator" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">The Operator element defines operator criteria for the SearchValue. For instance if the requester wishes to return a result set of all prices &gt; $600, the transaction would contain a SearchTerm data type with a SearchValue of ‘600’, an SearchValueInclusive of ‘0’ and an OPERATOR value of ‘&gt;.’
The valid values for OPERATOR are: "Greater Then, Less Then, Greater Then or Equals, Less Then or Equals, Equals</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="SearchQualifier" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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.</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="UserArea" minOccurs="0" />
    </xsd:sequence>
</xsd:complexType>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
SearchValueText nsA:SearchValueText 0 (1)
InclusiveIndicator nsA:InclusiveIndicator 0 (1)
ExactMatchIndicator nsA:ExactMatchIndicator 0 (1)
Operator nsA:Operator 0 (1)
SearchQualifier nsA:SearchQualifier 0 (1)
UserArea nsA:UserArea 0 (1)
Collapse Derivation Tree:
Collapse References:
nsA:SearchTerm