Interface | osid.repository.rules.CompositionEnablerRepositoryAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCompositionEnablers | ||
Description |
Tests if this user can alter composition
enabler/repository 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 | canAssignCompositionEnablersToRepository | ||
Description |
Tests if this user can alter composition
enabler/repository 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 | repositoryId | the Id of the Repository |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | repositoryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableRepositoryIds | ||
Description |
Gets a list of repositories including and under the given repository node in which any repository enabler can be assigned. | ||
Parameters | osid.id.Id | repositoryId | the Id of the Repository |
Return | osid.id.IdList | list of assignable composition Ids | |
Errors | NULL_ARGUMENT | repositoryId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableRepositoryIdsForCompositionEnabler | ||
Description |
Gets a list of repositories including and under the given repository node in which a specific repository enabler can be assigned. | ||
Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.id.Id | compositionEnablerId | the Id of the CompositionEnabler | |
Return | osid.id.IdList | list of assignable repository Ids | |
Errors | NULL_ARGUMENT | repositoryId or compositionEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCompositionEnablerToRepository | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | compositionEnablerId | the Id of the CompositionEnabler |
osid.id.Id | repositoryId | the Id of the Repository | |
Errors | ALREADY_EXISTS | compositionEnablerId is alraedy assigned to
repositoryId | |
NOT_FOUND | compositionEnablerId or repositoryId not
found | ||
NULL_ARGUMENT | compositionEnablerId or repositoryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCompositionEnablerFromRepository | ||
Description |
Removes a | ||
Parameters | osid.id.Id | compositionEnablerId | the Id of the CompositionEnabler |
osid.id.Id | repositoryId | the Id of the Repository | |
Errors | NOT_FOUND | compositionEnablerId or repositoryId not
found or compositionEnablerId not assigned to
repositoryId | |
NULL_ARGUMENT | compositionEnablerId or repositoryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCompositionEnablerToRepository | ||
Description |
Moves a | ||
Parameters | osid.id.Id | compositionEnablerId | the Id of the CompositionEnabler |
osid.id.Id | fromRepositoryId | the Id of the current Repository | |
osid.id.Id | toRepositoryId | the Id of the destination Repository | |
Errors | NOT_FOUND | compositionEnablerId, fromRepositoryId, or
toRepositoryId not found or compositionEnablerId not
mapped to fromRepositoryId | |
NULL_ARGUMENT | compositionEnablerId, fromRepositoryId, or
toRepositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |