Interface | osid.repository.CompositionRepositorySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | useComparativeCompositionRepositoryView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCompositionRepositoryView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | canLookupCompositionRepositoryMappings | ||
Description |
Tests if this user can perform lookups of
composition/repository mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionIdsByRepository | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | repositoryId | Id of the Repository |
Return | osid.id.IdList | list of related composition Ids | |
Errors | NOT_FOUND | repositoryId is not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionsByRepository | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | repositoryId | Id of the Repository |
Return | osid.repository.CompositionList | list of related compositions | |
Errors | NOT_FOUND | repositoryId is not found | |
NULL_ARGUMENT | repositoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionIdsByRepositories | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | repositoryIds | list of repository Ids |
Return | osid.id.IdList | list of composition Ids | |
Errors | NULL_ARGUMENT | repositoryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCompoitionsByRepositories | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | repositoryIds | list of repository Ids |
Return | osid.repository.CompositionList | list of Compositions | |
Errors | NULL_ARGUMENT | repositoryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRepositoryIdsByComposition | ||
Description |
Gets the | ||
Parameters | osid.id.Id | compositionId | Id of a Composition |
Return | osid.id.IdList | list of repository Ids | |
Errors | NOT_FOUND | compositionId is not found | |
NULL_ARGUMENT | compositionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRepositoriesByComposition | ||
Description |
Gets the | ||
Parameters | osid.id.Id | compositionId | Id of a Composition |
Return | osid.repository.RepositoryList | list of repositories | |
Errors | NOT_FOUND | compositionId is not found | |
NULL_ARGUMENT | compositionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |