OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderStoreSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Order to Store mappings. An Order may appear in multiple Stores. Each Store may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupOrderStoreMappings
Description

Tests if this user can perform lookups of order/store mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeStoreView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryStoreView
Description

A complete view of the Order and Store returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetOrderIdsByStore
Description

Gets the list of order Ids associated with a Store.

Parametersosid.id.IdstoreId Id of a Store.
Returnosid.id.IdListlist of related order Ids
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOrdersByStore
Description

Gets the list of Orders associated with a Store.

Parametersosid.id.IdstoreId Id of a Store
Returnosid.ordering.OrderListlist of related orders
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOrderIdsByStores
Description

Gets the list of Order Ids corresponding to a list of Store objects.

Parametersosid.id.IdListstoreIdslist of store Ids
Returnosid.id.IdListlist of order Ids
ErrorsNULL_ARGUMENT storeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOrdersByStores
Description

Gets the list of Orders corresponding to a list of Stores.

Parametersosid.id.IdListstoreIdslist of store Ids
Returnosid.ordering.OrderListlist of orders
ErrorsNULL_ARGUMENT storeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoreIdsByOrder
Description

Gets the list of Store Ids mapped to an Order.

Parametersosid.id.IdorderId Id of an Order
Returnosid.id.IdListlist of store Ids
ErrorsNOT_FOUND orderId is not found
NULL_ARGUMENT orderId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoresByOrder
Description

Gets the list of Store objects mapped to an Order.

Parametersosid.id.IdorderId Id of an Order
Returnosid.ordering.StoreListlist of store Ids
ErrorsNOT_FOUND orderId is not found
NULL_ARGUMENT orderId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.