Interface | osid.offering.rules.CanonicalUnitProcessorEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes canonical unit processor
enablers. The data for create and update is provided via the
| ||
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 | canCreateCanonicalUnitProcessorEnabler | ||
Description |
Tests if this user can create canonical unit processor
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if CanonicalUnitProcessorEnabler
creation is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCanonicalUnitProcessorEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | canonicalUnitProcessorEnablerRecordTypes | array of canonical unit processor enabler record types |
Return | boolean | true if CanonicalUnitProcessorEnabler
creation using the specified record Types is supported,
false otherwise | |
Errors | NULL_ARGUMENT | canonicalUnitProcessorEnablerRecordTypes is null
| |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitProcessorEnablerFormForCreate | ||
Description |
Gets the canonical unit processor enabler form for creating new canonical unit processor enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | canonicalUnitProcessorEnablerRecordTypes | array of canonical unit processor enabler record types |
Return | osid.offering.rules.CanonicalUnitProcessorEnablerForm | the canonical unit processor enabler form | |
Errors | NULL_ARGUMENT | canonicalUnitProcessorEnablerRecordTypes is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCanonicalUnitProcessorEnabler | ||
Description |
Creates a new | ||
Parameters | osid.offering.rules.CanonicalUnitProcessorEnablerForm | canonicalUnitProcessorEnablerForm | the form for this CanonicalUnitProcessorEnabler |
Return | osid.offering.rules.CanonicalUnitProcessorEnabler | the new CanonicalUnitProcessorEnabler | |
Errors | ILLEGAL_STATE | canonicalUnitProcessorEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | canonicalUnitProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | canonicalUnitProcessorEnablerForm did not originate from
getCanonicalUnitProcessorEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCanonicalUnitProcessorEnablers | ||
Description |
Tests if this user can update canonical unit processor
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if CanonicalUnitProcessorEnabler
modification is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitProcessorEnablerFormForUpdate | ||
Description |
Gets the canonical unit processor enabler form for updating an existing canonical unit processor enabler. A new canonical unit processor enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | canonicalUnitProcessorEnablerId | the Id of the CanonicalUnitProcessorEnabler |
Return | osid.offering.rules.CanonicalUnitProcessorEnablerForm | the canonical unit processor enabler form | |
Errors | NOT_FOUND | canonicalUnitProcessorEnablerId is not found | |
NULL_ARGUMENT | canonicalUnitProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCanonicalUnitProcessorEnabler | ||
Description |
Updates an existing canonical unit processor enabler. | ||
Parameters | osid.offering.rules.CanonicalUnitProcessorEnablerForm | canonicalUnitProcessorEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | canonicalUnitProcessorEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | canonicalUnitProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | canonicalUnitProcessorEnablerForm did not originate from
getCanonicalUnitProcessorEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCanonicalUnitProcessorEnablers | ||
Description |
Tests if this user can delete canonical unit processor
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if CanonicalUnitProcessorEnabler
deletion is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCanonicalUnitProcessorEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | canonicalUnitProcessorEnablerId | the Id of the CanonicalUnitProcessorEnabler
to remove |
Errors | NOT_FOUND | canonicalUnitProcessorEnablerId not found | |
NULL_ARGUMENT | canonicalUnitProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCanonicalUnitProcessorEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CanonicalUnitProcessorEnabler
aliasing is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCanonicalUnitProcessorEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | canonicalUnitProcessorEnablerId | the Id of a CanonicalUnitProcessorEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | canonicalUnitProcessorEnablerId not found | ||
NULL_ARGUMENT | canonicalUnitProcessorEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |