Interface | osid.hold.rules.HoldEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Hold enablers may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
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 | canSearchHoldEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedOublietteView | ||
Description |
Federates the view for methods in this session. A federated view will include hold enablers in oubliettes which are children of this oubliette in the oubliette hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOublietteView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this oubliette only. | ||
Compliance | mandatory | This method is 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 | getHoldEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.hold.rules.HoldEnablerQuery | holdEnablerQuery | the hold enabler query |
Return | osid.hold.rules.HoldEnablerList | the returned HoldEnablerList | |
Errors | NULL_ARGUMENT | holdEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | holdEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |