| Interface | osid.repository.AssetRepositoryAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Moving or adding a reference of an | ||
| Method | canAssignAssets | ||
| Description |
Tests if this user can alter asset/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 | canAssignAssetsToRepository | ||
| Description |
Tests if this user can alter asset/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 asset can be assigned. | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
| Return | osid.id.IdList | list of assignable repository Ids | |
| Errors | NULL_ARGUMENT | repositoryId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableRepositoryIdsForAsset | ||
| Description |
Gets a list of repositories including and under the given repository node in which a specific asset can be assigned. | ||
| Parameters | osid.id.Id | repositoryId | the Id of the Repository |
osid.id.Id | assetId | the Id of the Asset | |
| Return | osid.id.IdList | list of assignable repository Ids | |
| Errors | NULL_ARGUMENT | repositoryId or assetId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAssetToRepository | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | assetId | the Id of the Asset |
osid.id.Id | repositoryId | the Id of the Repository | |
| Errors | ALREADY_EXISTS | assetId already assigned to repositoryId | |
| NOT_FOUND | assetId or repositoryId not found | ||
| NULL_ARGUMENT | assetId or repositoryId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAssetFromRepository | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | assetId | the Id of the Asset |
osid.id.Id | repositoryId | the Id of the Repository | |
| Errors | NOT_FOUND | assetId or repositoryId not found or
assetId not assigned to repositoryId | |
| NULL_ARGUMENT | assetId or repositoryId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |