Interface | osid.offering.rules.CanonicalUnitEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
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 | canLookupCanonicalUnitEnablerRules | ||
Description |
Tests if this user can perform lookups of canonical
unit enabler/canonical unit mappings. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known lookup methods in this
session will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCanonicalUnitEnablerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCanonicalUnitEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 catalogue 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 | getCanonicalUnitEnablerIdsForCanonicalUnit | ||
Description |
Gets the | ||
Parameters | osid.id.Id | canonicalUnitId | Id of the CanonicalUnit |
Return | osid.id.IdList | the canonical unit enabler Ids | |
Errors | NOT_FOUND | canonicalUnitId is not found | |
NULL_ARGUMENT | canonicalUnit is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitEnablersForCanonicalUnit | ||
Description |
Gets the | ||
Parameters | osid.id.Id | canonicalUnitId | Id of the CanonicalUnit |
Return | osid.offering.rules.CanonicalUnitEnablerList | the canonical unit enablers | |
Errors | NOT_FOUND | canonicalUnitId is not found | |
NULL_ARGUMENT | canonicalUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitIdsForCanonicalUnitEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | canonicalUnitEnablerId | Id of a CanonicalUnitEnabler |
Return | osid.id.IdList | list of canonical unit Ids | |
Errors | NOT_FOUND | canonicalUnitEnablerId is not found | |
NULL_ARGUMENT | canonicalUnitEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitsForCanonicalUnitEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | canonicalUnitEnablerId | Id of a CanonicalUnitEnabler |
Return | osid.offering.CanonicalUnitList | list of canonical units | |
Errors | NOT_FOUND | canonicalUnitEnablerId is not found | |
NULL_ARGUMENT | canonicalUnitEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |