Interface | osid.offering.rules.CanonicalUnitEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
CanonicalUnit constrainer enablers may have a query record
indicated by their respective record types. The query record
is accessed via the | ||
Method | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchCanonicalUnitEnablers | ||
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 | useFederatedCatalogueView | ||
Description |
Federates the view for methods in this session. A federated view will include canonical unit enablers in catalogues which are children of this broker in the catalogue hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogueView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this catalogue only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCanonicalUnitEnablerQuery | ||
Description |
Gets a canonical unit enabler query. | ||
Return | osid.offering.rules.CanonicalUnitEnablerQuery | the canonical unit enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.offering.rules.CanonicalUnitEnablerQuery | canonicalUnitEnablerQuery | the canonical unit constraienr enabler query |
Return | osid.offering.rules.CanonicalUnitEnablerList | the returned CanonicalUnitEnablerList | |
Errors | NULL_ARGUMENT | canonicalUnitEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | canonicalUnitEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |