Interface | osid.cataloging.rules.CatalogEnablerCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupCatalogEnablerCatalogMappings | ||
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 | useComparativeCatalogEnablerCatalogView | ||
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 | usePlenaryCatalogEnablerCatalogView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCatalogEnablerIdsByCatalog | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | catalogId | Id of the Catalog |
Return | osid.id.IdList | list of related 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 | getCatalogEnablersByCatalog | ||
Description |
Gets the list of catalog enablers associated with a
| ||
Parameters | osid.id.Id | catalogId | Id of the Catalog |
Return | osid.cataloging.rules.CatalogEnablerList | list of related 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 | getCatalogEnablerIdsByCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | catalogIds | list of catalog Ids |
Return | osid.id.IdList | list of catalog enabler Ids | |
Errors | NULL_ARGUMENT | catalogIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogEnablersByCatalogs | ||
Description |
Gets the list of catalog enablers corresponding to a
list of | ||
Parameters | osid.id.IdList | catalogIds | list of catalog Ids |
Return | osid.cataloging.rules.CatalogEnablerList | list of catalog enablers | |
Errors | NULL_ARGUMENT | catalogIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogIdsByCatalogEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogEnablerId | Id of a CatalogEnabler |
Return | osid.id.IdList | 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. | |
Method | getCatalogsByCatalogEnabler | ||
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. |