Verbs

Develop > Persistence layer > WebSphere Commerce use of Open Applications Group (OAGIS) messaging

Verbs

A verb represents an operation that can be performed on a noun. For example, an "Order" noun has a specified operation that is performed in response to the verb "Get" (in this case, providing details to the client about the Order). Although OAGIS messaging defines a number of verbs; WebSphere Commerce uses a subset.

OAGIS verbs not supported by WebSphere Commerce

WebSphere Commerce does not support any of the deprecated OAGIS verbs. In addition, WebSphere Commerce services do not promote the use of:

Verb Rationale
Cancel The Cancel verb is not supported because in the majority of WebSphere Commerce scenarios, a Cancel is actually a processing operation with a cancel action. It is not simply an undo of some previously requested operation, for which a simple confirmation would be sufficient. It is typically a fairly complex business process, with a response message that indicates through its payload details of what happened during the cancellation. For example, canceling an order may have restocking fee implications, or at the very least would require a response message to be delivered to the client with a transaction ID for the request.
Load The Load verb represents an event that does not exist within WebSphere Commerce.
Post The Post verb represents an event that does not exist within WebSphere Commerce.
Update The Update verb is not used because it is so close in semantic meaning to the Change verb. WebSphere Commerce supports the Change verb, and an Update action within the Change verb.

Get Request and the Show Response
Get requests are requests for data, and use the Get verb, and return a Show response. The Get verb will indicate the search criteria used to retrieve the business objects along with paging options for paged requests. The Show response will include the business objects that match the search criteria .

Process request and the acknowledge response
Process is used when the client is submitting a new business object, canceling an existing business object, or invoking processing logic against an existing business object. The Acknowledge response will include the shell of the business object that was processed, containing at a minimum the unique identifier for the new or changed business object.

Change Request / Respond Response
Change is used to notify the master repository that they should change a business object that they own. The Change message will contain the verb and the noun. The noun will contain the information to uniquely identify itself and the attributes to change. For example, when adding a contact to a customer's contact list (address book), the noun specified will contain the contact information to add along with the information to uniquely identify the Person business object.

Sync request and the ConfirmBOD response
Sync is used to notify interested parties the current state of the business objects that the system manages. Only the system that contains the master data record should be sending Sync requests. Sync is used to synchronize the business object or objects across systems and is initiated by the system that holds the master data record for the business object.

Related concepts

Change Request / Respond Response
Get Request and the Show Response
WebSphere Commerce use of Open Applications Group (OAGIS) messaging
Process request and the acknowledge response
Sync request and the ConfirmBOD response

+
Search Tips | Advanced Search

Verb	Rationale
Cancel	The Cancel verb is not supported because in the majority of WebSphere Commerce scenarios, a Cancel is actually a processing operation with a cancel action. It is not simply an undo of some previously requested operation, for which a simple confirmation would be sufficient. It is typically a fairly complex business process, with a response message that indicates through its payload details of what happened during the cancellation. For example, canceling an order may have restocking fee implications, or at the very least would require a response message to be delivered to the client with a transaction ID for the request.
Load	The Load verb represents an event that does not exist within WebSphere Commerce.
Post	The Post verb represents an event that does not exist within WebSphere Commerce.
Update	The Update verb is not used because it is so close in semantic meaning to the Change verb. WebSphere Commerce supports the Change verb, and an Update action within the Change verb.