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

This session provides methods for retrieving Store objects. The Store represents a collection of orders, products, and price schedules.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

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

Returnboolean false if lookup methods are 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 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.
MethodgetStore
Description

Gets the Store specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Store may have a different Id than requested, such as the case where a duplicate Id was assigned to a Store and retained for compatibility.

Parametersosid.id.IdstoreId Id of the Store
Returnosid.ordering.Storethe store
ErrorsNOT_FOUND storeId not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetStoresByIds
Description

Gets a StoreList corresponding to the given IdList. In plenary mode, the returned list contains all of the stores specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Stores may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListstoreIdsthe list of Ids to retrieve
Returnosid.ordering.StoreListthe returned Store list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT storeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoresByGenusType
Description

Gets a StoreList corresponding to the given store genus Type which does not include stores of genus types derived from the specified Type. In plenary mode, the returned list contains all known stores or an error results. Otherwise, the returned list may contain only those stores that are accessible through this session.

Parametersosid.type.TypestoreGenusTypea store genus type
Returnosid.ordering.StoreListthe returned Store list
ErrorsNULL_ARGUMENT storeGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoresByParentGenusType
Description

Gets a StoreList corresponding to the given store genus Type and include any additional stores with genus types derived from the specified Type. In plenary mode, the returned list contains all known stores or an error results. Otherwise, the returned list may contain only those stores that are accessible through this session.

Parametersosid.type.TypestoreGenusTypea store genus type
Returnosid.ordering.StoreListthe returned Store list
ErrorsNULL_ARGUMENT storeGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoresByRecordType
Description

Gets a StoreList containing the given repository record Type. In plenary mode, the returned list contains all known stores or an error results. Otherwise, the returned list may contain only those stores that are accessible through this session.

Parametersosid.type.TypestoreRecordTypea store record type
Returnosid.ordering.StoreListthe returned Store list
ErrorsNULL_ARGUMENT storeRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoresByProvider
Description

Gets a StoreList for the given provider. In plenary mode, the returned list contains all known stores or an error results. Otherwise, the returned list may contain only those stores that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.ordering.StoreListthe returned Store list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStores
Description

Gets all Stores. In plenary mode, the returned list contains all known stores or an error results. Otherwise, the returned list may contain only those stores that are accessible through this session.

Returnosid.ordering.StoreLista list of Stores
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.