Interface | osid.cataloging.rules.CatalogEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | getCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalog | ||
Description |
Gets the | ||
Return | osid.cataloging.Catalog | the catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupCatalogEnablerRules | ||
Description |
Tests if this user can perform lookups of catalog
enabler/catalog 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 | useComparativeCatalogEnablerRuleView | ||
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 | usePlenaryCatalogEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include catalog enablers in catalogs which are children of this catalog in the catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCatalogEnablerIdsForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | Id of the Catalog |
Return | osid.id.IdList | the catalog enabler Ids | |
Errors | NOT_FOUND | catalogId is not found | |
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogEnablersForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | Id of the Catalog |
Return | osid.cataloging.rules.CatalogEnablerList | the catalog enablers | |
Errors | NOT_FOUND | catalogId is not found | |
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogIdsForCatalogEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogEnablerId | Id of a CatalogEnabler |
Return | osid.id.IdList | list of catalog Ids | |
Errors | NOT_FOUND | catalogEnablerId is not found | |
NULL_ARGUMENT | catalogEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogsForCatalogEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogEnablerId | Id of a CatalogEnabler |
Return | osid.cataloging.CatalogList | list of catalogs | |
Errors | NOT_FOUND | catalogEnablerId is not found | |
NULL_ARGUMENT | catalogEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |