DataArea

Is where the information that the BOD message carries is provided, in this case GetCatalog. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (Catalog).

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

Element information

Content

• Sequence [1..1]
  1. Get [1..1]    The Get verb is to communicate to a business software component a request for an existing piece or pieces of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across the nouns it is paired with.The Get is designed to retrieval of information by using that information's primary retrieval field, or key field. The Get verb may also be used to request several documents at once. Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned.
  2. Catalog [1..*]    Catalog is a list of items or commodities. The items may be arranged according to a classification scheme. The Catalog can identify the classification scheme it uses, and the classifications and features that are defined within that scheme. Within the Catalog, each item can be classified into one oe more categories , and the specifications of each item can be identified. A Catalog has at least one publisher and one or many suppliers for the items in the Catalog.

Attributes

None

Used in

• Type GetCatalogType (Element GetCatalog)

Sample instance

<DataArea>
   <Get>
      <Expression>token</Expression>
   </Get>
   <Catalog>
      <CatalogHeader>
         <DocumentID>...
         </DocumentID>
         <AlternateDocumentID>...
         </AlternateDocumentID>
         <LastModificationDateTime>2000-01-01</LastModificationDateTime>
         <DocumentDateTime>2000-01-01</DocumentDateTime>
         <Description>string</Description>
         <Note>string</Note>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <Name>string</Name>
         <CurrencyCode>AED</CurrencyCode>
         <EffectiveTimePeriod>...
         </EffectiveTimePeriod>
         <UsageRestrictionCode>normalizedString</UsageRestrictionCode>
         <ClassificationScheme>...
         </ClassificationScheme>
         <PublisherParty>...
         </PublisherParty>
         <SupplierParty>...
         </SupplierParty>
         <Party>...
         </Party>
         <UserArea>
            <!--any element-->
         </UserArea>
      </CatalogHeader>
      <ClassificationScheme>
         <ClassificationSchemeID>normalizedString</ClassificationSchemeID>
         <Description>string</Description>
         <Note>string</Note>
         <Classification>...
         </Classification>
         <Property>...
         </Property>
         <ClassificationDefinition>...
         </ClassificationDefinition>
         <UserArea>
            <!--any element-->
         </UserArea>
      </ClassificationScheme>
      <CatalogLine>
         <Item>...
         </Item>
         <UOMCode>normalizedString</UOMCode>
         <SupplierParty>...
         </SupplierParty>
         <ItemPrice>...
         </ItemPrice>
         <Description>string</Description>
         <Note>string</Note>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <UserArea>
            <!--any element-->
         </UserArea>
      </CatalogLine>
   </Catalog>
</DataArea>