Interface | osid.ordering.StoreLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupStores | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeStoreView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryStoreView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Parameters | osid.id.Id | storeId | Id of the Store |
Return | osid.ordering.Store | the store | |
Errors | NOT_FOUND | storeId not found | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStoresByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | storeIds | the list of Ids to retrieve |
Return | osid.ordering.StoreList | the returned Store list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | storeIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoresByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | storeGenusType | a store genus type |
Return | osid.ordering.StoreList | the returned Store list | |
Errors | NULL_ARGUMENT | storeGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoresByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | storeGenusType | a store genus type |
Return | osid.ordering.StoreList | the returned Store list | |
Errors | NULL_ARGUMENT | storeGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoresByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | storeRecordType | a store record type |
Return | osid.ordering.StoreList | the returned Store list | |
Errors | NULL_ARGUMENT | storeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoresByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.ordering.StoreList | the returned Store list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStores | ||
Description |
Gets all | ||
Return | osid.ordering.StoreList | a list of Stores | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |