Interface | osid.repository.AssetLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving assets. An
This lookup session defines several views:
The methods Assets may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupAssets | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAssetView | ||
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 | usePlenaryAssetView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedRepositoryView | ||
Description |
Federates the view for methods in this session. A federated view will include assets in repositories which are children of this repository in the repository hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedRepositoryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this repository only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAsset | ||
Description |
Gets the | ||
Parameters | osid.id.Id | assetId | the Id of the Asset to retrieve |
Return | osid.repository.Asset | the returned Asset | |
Errors | NOT_FOUND | no Asset found with the given Id | |
NULL_ARGUMENT | assetId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssetsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | assetIds | the list of Ids to retrieve |
Return | osid.repository.AssetList | the returned Asset list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | assetIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssetsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assetGenusType | an asset genus type |
Return | osid.repository.AssetList | the returned Asset list | |
Errors | NULL_ARGUMENT | assetGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssetsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assetGenusType | an asset genus type |
Return | osid.repository.AssetList | the returned Asset list | |
Errors | NULL_ARGUMENT | assetGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssetsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assetRecordType | an asset record type |
Return | osid.repository.AssetList | the returned Asset list | |
Errors | NULL_ARGUMENT | assetRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssetsByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.repository.AssetList | the returned Asset list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssets | ||
Description |
Gets all | ||
Return | osid.repository.AssetList | a list of Assets | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |