Interface | osid.provisioning.RequestSmartDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartDistributors | ||
Description |
Tests if this user can manage smart distributors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart distributor management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestQuery | ||
Description |
Gets a request query. | ||
Return | osid.provisioning.RequestQuery | the request query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestSearchOrder | ||
Description |
Gets a request search order. | ||
Return | osid.provisioning.RequestSearchOrder | the request search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyRequestQuery | ||
Description |
Applies a request query to this distributor. | ||
Parameters | osid.provisioning.RequestQuery | requestQuery | the request query |
Errors | NULL_ARGUMENT | requestQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | requestQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectRequestQuery | ||
Description |
Gets a request query inspector for this distributor. | ||
Return | osid.provisioning.RequestQueryInspector | the request query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyRequestSequencing | ||
Description |
Applies a request search order to this distributor. | ||
Parameters | osid.provisioning.RequestSearchOrder | requestSearchOrder | the request search order |
Errors | NULL_ARGUMENT | requestSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | requestSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequestQueryFromInspector | ||
Description |
Gets a request query from an inspector. | ||
Parameters | osid.provisioning.RequestQueryInspector | requestQueryInspector | a request query inspector |
Return | osid.provisioning.RequestQuery | the request query | |
Errors | NULL_ARGUMENT | requestQueryInspector is null | |
UNSUPPORTED | requestQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |