Interface | osid.cataloging.rules.CatalogEnablerCatalogAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCatalogEnablers | ||
Description |
Tests if this user can alter catalog enabler/catalog
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignCatalogEnablersToCatalog | ||
Description |
Tests if this user can alter catalog enabler/catalog
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | catalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCatalogIds | ||
Description |
Gets a list of catalogs including and under the given catalog node in which any catalog enabler can be assigned. | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
Return | osid.id.IdList | list of assignable catalog Ids | |
Errors | NULL_ARGUMENT | catalogId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCatalogIdsForCatalogEnabler | ||
Description |
Gets a list of catalogs including and under the given catalog node in which a specific catalog enabler can be assigned. | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.id.Id | catalogEnablerId | the Id of the CatalogEnabler | |
Return | osid.id.IdList | list of assignable catalog Ids | |
Errors | NULL_ARGUMENT | catalogId or catalogEnablerId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCatalogEnablerToCatalog | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | catalogEnablerId | the Id of the CatalogEnabler |
osid.id.Id | catalogId | the Id of the Catalog | |
Errors | ALREADY_EXISTS | catalogEnablerId is already assigned to catalogId
| |
NOT_FOUND | catalogEnablerId or catalogId not found | ||
NULL_ARGUMENT | catalogEnablerId or catalogId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCatalogEnablerFromCatalog | ||
Description |
Removes a | ||
Parameters | osid.id.Id | catalogEnablerId | the Id of the CatalogEnabler |
osid.id.Id | catalogId | the Id of the Catalog | |
Errors | NOT_FOUND | catalogEnablerId or catalogId not found or
catalogEnablerId is not assigned to catalogId | |
NULL_ARGUMENT | catalogEnablerId or catalogId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCatalogEnablerToCatalog | ||
Description |
Moves a | ||
Parameters | osid.id.Id | catalogEnablerId | the Id of the CatalogEnabler |
osid.id.Id | fromCatalogId | the Id of the current Catalog | |
osid.id.Id | toCatalogId | the Id of the destination Catalog | |
Errors | NOT_FOUND | catalogEnablerId, fromCatalogEnablerId, or
toCatalogEnablerId not found or catalogEnablerId not
mapped to fromCatalogId | |
NULL_ARGUMENT | catalogEnablerId, fromCatalogId, or toCatalogId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |