Interface | osid.offering.rules.CanonicalUnitProcessorEnablerCatalogueAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCanonicalUnitProcessorEnablers | ||
Description |
Tests if this user can alter canonical unit processor
enabler/catalogue 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 | canAssignCanonicalUnitProcessorEnablersToCatalogue | ||
Description |
Tests if this user can alter canonical unit processor
enabler/catalogue 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 | catalogueId | the Id of the Catalogue |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | catalogueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCatalogueIds | ||
Description |
Gets a list of catalogues including and under the given catalogue node in which any canonical unit processor enabler can be assigned. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.id.IdList | list of assignable catalogue Ids | |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCatalogueIdsForCanonicalUnitProcessorEnabler | ||
Description |
Gets a list of catalogues including and under the given catalogue node in which a specific canonical unit processor enabler can be assigned. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
osid.id.Id | canonicalUnitProcessorEnablerId | the Id of the CanonicalUnitProcessorEnabler | |
Return | osid.id.IdList | list of assignable catalogue Ids | |
Errors | NULL_ARGUMENT | catalogueId or canonicalUnitProcessorEnablerId
is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCanonicalUnitProcessorEnablerToCatalogue | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | canonicalUnitProcessorEnablerId | the Id of the CanonicalUnitProcessorEnabler |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Errors | ALREADY_EXISTS | canonicalUnitProcessorEnablerId already assigned to
catalogueId | |
NOT_FOUND | canonicalUnitProcessorEnablerId or catalogueId
not found | ||
NULL_ARGUMENT | canonicalUnitProcessorEnablerId or catalogueId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCanonicalUnitProcessorEnablerFromCatalogue | ||
Description |
Removes a | ||
Parameters | osid.id.Id | canonicalUnitProcessorEnablerId | the Id of the CanonicalUnitProcessorEnabler |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Errors | NOT_FOUND | canonicalUnitProcessorEnablerId or catalogueId
not found or canonicalUnitProcessorEnablerId not
assigned to catalogueId | |
NULL_ARGUMENT | canonicalUnitProcessorEnablerId or catalogueId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCanonicalUnitProcessorEnablerToCatalogue | ||
Description |
Moves a | ||
Parameters | osid.id.Id | canonicalUnitProcessorEnablerId | the Id of the CanonicalUnitProcessorEnabler |
osid.id.Id | fromCatalogueId | the Id of the current Catalogue | |
osid.id.Id | toCatalogueId | the Id of the destination Catalogue | |
Errors | NOT_FOUND | canonicalUnitProcessorEnablerId, fromCatalogueId, or
toCatalogueId not found or canonicalUnitProcessorEnablerId,
not mapped to fromCatalogueId | |
NULL_ARGUMENT | canonicalUnitProcessorEnablerId, fromCatalogueId, or
toCatalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |