Interface | osid.repository.rules.CompositionEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Composition enablers may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getRepositoryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Repository Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRepository | ||
Description |
Gets the | ||
Return | osid.repository.Repository | the repository | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchCompositionEnablers | ||
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 | useFederatedRepositoryView | ||
Description |
Federates the view for methods in this session. A federated view will include composition enablers in repositories which are children of this repository in the repository hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedRepositoryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this repository only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCompositionEnablerQuery | ||
Description |
Gets a composition enabler query. | ||
Return | osid.repository.rules.CompositionEnablerQuery | the composition enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.repository.rules.CompositionEnablerQuery | compositionEnablerQuery | the composition enabler query |
Return | osid.repository.rules.CompositionEnablerList | the returned CompositionEnablerList | |
Errors | NULL_ARGUMENT | compositionEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | compositionEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |