Interface | osid.ordering.ProductLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getStoreId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Store Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Return | osid.ordering.Store | the store | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupProducts | ||
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 | useComparativeProductView | ||
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 | usePlenaryProductView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedStoreView | ||
Description |
Federates the view for methods in this session. A federated view will include products in stores which are children of this store in the store hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedStoreView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this store only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProduct | ||
Description |
Gets the | ||
Parameters | osid.id.Id | productId | Id of the Product |
Return | osid.ordering.Product | the product | |
Errors | NOT_FOUND | productId not found | |
NULL_ARGUMENT | productId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProductsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | productIds | the list of Ids to retrieve |
Return | osid.ordering.ProductList | the returned Product list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | productIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | productGenusType | a product genus type |
Return | osid.ordering.ProductList | the returned Product list | |
Errors | NULL_ARGUMENT | productGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | productGenusType | a product genus type |
Return | osid.ordering.ProductList | the returned Product list | |
Errors | NULL_ARGUMENT | productGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | productRecordType | a product record type |
Return | osid.ordering.ProductList | the returned Product list | |
Errors | NULL_ARGUMENT | productRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductsByCode | ||
Description |
Gets the | ||
Parameters | string | code | a product code |
Return | osid.ordering.ProductList | the product | |
Errors | NOT_FOUND | code not found | |
NULL_ARGUMENT | code is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProductsByPriceSchedule | ||
Description |
Gets a | ||
Parameters | osid.id.Id | priceScheduleId | a price schedule Id |
Return | osid.ordering.ProductList | the product list | |
Errors | NULL_ARGUMENT | priceScheduleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProducts | ||
Description |
Gets all | ||
Return | osid.ordering.ProductList | a list of Products | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |