| Interface | osid.repository.rules.CompositionEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to apply | ||
| Method | getRepositoryId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Repository Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepository | ||
| Description |
Gets the | ||
| Return | osid.repository.Repository | the repository | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignCompositionEnablers | ||
| Description |
Tests if this user can alter composition
enabler/composition 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 | assignCompositionEnablerToComposition | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | compositionEnablerId | the Id of the CompositionEnabler |
osid.id.Id | compositionId | the Id of the Composition | |
| Errors | ALREADY_EXISTS | compositionEnablerId is already applied to
compositionId | |
| NOT_FOUND | compositionEnablerId or compositionId not
found | ||
| NULL_ARGUMENT | compositionEnablerId or compositionId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignCompositionEnablerFromComposition | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | compositionEnablerId | the Id of the CompositionEnabler |
osid.id.Id | compositionId | the Id of the Composition | |
| Errors | NOT_FOUND | compositionEnablerId or compositionId not
found or compositionEnablerId not applied to
compositionId | |
| NULL_ARGUMENT | compositionEnablerId or compositionId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceCompositionEnablers | ||
| Description |
Tests if this user can order | ||
| Return | boolean | false if CompositionEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveCompositionEnablerAhead | ||
| Description |
Reorders composiiton enablers for a composiiton by moving the specified composiiton enabler in front of a reference composiiton enabler. | ||
| Parameters | osid.id.Id | composiitonEnablerId | the Id of a CompositionEnabler |
osid.id.Id | composiitonId | the Id of a Composition | |
osid.id.Id | referenceId | the reference composiiton enabler Id | |
| Errors | NOT_FOUND | composiitonEnablerId, composiitonId, or referenceId
not found or, composiitonEnablerId or
referenceId not related to composiitonId | |
| NULL_ARGUMENT | composiitonEnablerId, composiitonId, or referenceId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveCompositionEnablerBehind | ||
| Description |
Reorders composiiton enablers for a composiiton by moving the specified composiiton enabler behind a reference composiiton enabler. | ||
| Parameters | osid.id.Id | composiitonEnablerId | the Id of a CompositionEnabler |
osid.id.Id | composiitonId | the Id of a Composition | |
osid.id.Id | referenceId | the reference composiiton enabler Id | |
| Errors | NOT_FOUND | composiitonEnablerId, composiitonId, or referenceId
not found or, composiitonEnablerId or
referenceId not related to composiitonId | |
| NULL_ARGUMENT | composiitonEnablerId, composiitonId, or referenceId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCompositionEnablers | ||
| Description |
Reorders a set of composiiton enablers for a composiiton. | ||
| Parameters | osid.id.Id[] | composiitonEnablerIds | the Ids for a set of CompositionEnablers |
osid.id.Id | composiitonId | the Id of a Composition | |
| Errors | NOT_FOUND | composiitonId not found or, an composiitonEnablerId
not related to composiitonId | |
| NULL_ARGUMENT | composiitonEnablerIds or composiitonId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |