Interface | osid.hold.rules.HoldEnablerSmartOublietteSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic oubliettes. A This | ||
Method | getOublietteId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Oubliette Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOubliette | ||
Description |
Gets the | ||
Return | osid.hold.Oubliette | the oubliette | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartOubliettes | ||
Description |
Tests if this user can manage smart oubliettes. 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 oubliette management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerQuery | ||
Description |
Gets a hold enabler query. | ||
Return | osid.hold.rules.HoldEnablerQuery | the hold enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerSearchOrder | ||
Description |
Gets a hold enabler search order. | ||
Return | osid.hold.rules.HoldEnablerSearchOrder | the hold enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyHoldEnablerQuery | ||
Description |
Applies a hold enabler query to this oubliette. | ||
Parameters | osid.hold.rules.HoldEnablerQuery | holdEnablerQuery | the hold enabler query |
Errors | NULL_ARGUMENT | holdEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | holdEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectHoldEnablerQuery | ||
Description |
Gets a hold enabler query inspector for this oubliette. | ||
Return | osid.hold.rules.HoldEnablerQueryInspector | the hold enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyHoldEnablerSequencing | ||
Description |
Applies a hold enabler search order to this oubliette. | ||
Parameters | osid.hold.rules.HoldEnablerSearchOrder | holdEnablerSearchOrder | the hold enabler search order |
Errors | NULL_ARGUMENT | holdEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | holdEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerQueryFromInspector | ||
Description |
Gets a hold enabler query from an inspector. | ||
Parameters | osid.hold.rules.HoldEnablerQueryInspector | holdEnablerQueryInspector | a hold enabler query inspector |
Return | osid.hold.rules.HoldEnablerQuery | the hold enabler query | |
Errors | NULL_ARGUMENT | holdEnablerQueryInspector is null | |
UNSUPPORTED | holdEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |