Interface | osid.offering.CanonicalUnitSmartCatalogueSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartCatalogues | ||
Description |
Tests if this user can manage smart catalogues. 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 catalogue management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitQuery | ||
Description |
Gets a canonical unit query. | ||
Return | osid.offering.CanonicalUnitQuery | the canonical unit query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitSearchOrder | ||
Description |
Gets a canonical unit search order. | ||
Return | osid.offering.CanonicalUnitSearchOrder | the canonical unit search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyCanonicalUnitQuery | ||
Description |
Applies a canonical unit query to this catalogue. | ||
Parameters | osid.offering.CanonicalUnitQuery | canonicalUnitQuery | the canonical unit query |
Errors | NULL_ARGUMENT | canonicalUnitQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | canonical unitQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectCanonicalUnitQuery | ||
Description |
Gets a canonical unit query inspector for this catalogue. | ||
Return | osid.offering.CanonicalUnitQueryInspector | the canonical unit query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyCanonicalUnitSequencing | ||
Description |
Applies a canonical unit search order to this catalogue. | ||
Parameters | osid.offering.CanonicalUnitSearchOrder | canonicalUnitSearchOrder | the canonical unit search order |
Errors | NULL_ARGUMENT | canonicalUnitSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | canonicalUnitSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitQueryFromInspector | ||
Description |
Gets a canonical unit query from an inspector. | ||
Parameters | osid.offering.CanonicalUnitQueryInspector | canonicalUnitQueryInspector | a query inspector |
Return | osid.offering.CanonicalUnitQuery | the canonical unit query | |
Errors | NULL_ARGUMENT | canonicalUnitQueryInspector is null | |
UNSUPPORTED | canonicalUnitQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |