Interface | osid.resourcing.AvailabilityQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Availabilities may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchAvailabilities | ||
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 | useFederatedFoundryView | ||
Description |
Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this foundry in the foundry hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFoundryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAvailabilityQuery | ||
Description |
Gets an availability query. | ||
Return | osid.resourcing.AvailabilityQuery | the availability query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.resourcing.AvailabilityQuery | availabilityQuery | the availability query |
Return | osid.resourcing.AvailabilityList | the returned AvailabilityList | |
Errors | NULL_ARGUMENT | availabilityQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | availabilityQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |