Chapter 5. Verbs

Chapter 5. Verbs
Prev		Next

Get

Uses the Component: GetType

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 for 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.

The first selection capability is called Field-Based Selection. Within a Get-base 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.
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.

Fields and Components

Table 5.1. Fields and Components

Name	Description	Occurrence	Type	Data Type
uniqueIndicator	Only return unique items, remove any duplicates. This has the same effect as an SQL statements DISTINCT command.	0..1	Attribute	udt:IndicatorType
maxItems	Communicates the maximum number of records which should be returned in a segment from a recordSet.	0..1	Attribute	qdt:PositiveIntegerNumericType
recordSetSaveIndicator	A true value indicates that receiver should save the record set	0..1	Attribute	udt:IndicatorType
recordSetStartNumber	The record number identifying the first record that should be returned in the Show response. This attribute is specified on subsequent Get requests, not the initial Get request. The systems may determine this number from the prior Show message (see the Show verb attributes for more information).	0..1	Attribute	qdt:PositiveIntegerNumericType
recordSetReferenceId	Unique identifier of the RecordSet. It is generated by the producer of the Show response as a result of the original Get request.	0..1	Attribute	xsd:normalizedString
Expression	The expression used to specify the selection or filter criteria.	1..*	Component	ExpressionType

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.1. Get

<Get uniqueIndicator="true" maxItems="10">
   <Expression>......</Expression>    [0..*]
</Get>