OSID Specifications
repository package
Version 3.1.0
repository package
Version 3.1.0
| Interface | osid.repository.AssetTemporalSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.repository.RepositoryManager | ||
osid.repository.RepositoryProxyManager | |||
| Description |
This session defines a means for accessing temporal
coverage of an asset. The views sorrespond to the view defined
in 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 | canLookupTemporalCoverage | ||
| Description |
Tests if this user can perform temporal lookups. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a
| ||
| Return | boolean | false if lookups 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 | getTemporalCoverage | ||
| Description |
Gets the temporal coverage related to the subject of this asset. Each element of the returned list describes a range of 2 times each described by a point in time with specified granularity and uncertainty. If the list contains more than one element, each element indicates a relevant time or period for the subject of this asset. | ||
| Parameters | osid.id.Id | assetId | Id of the Asset to query |
| Return | osid.calendaring.DateTimeIntervalList | a list of times relevant to the subject of this asset | |
| Errors | NOT_FOUND | assetId is not found | |
| NULL_ARGUMENT | assetId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetIdsByTemporalCoverage | ||
| Description |
Gets asset | ||
| Parameters | osid.calendaring.DateTime | from | starting range |
osid.calendaring.DateTime | to | ending range | |
| Return | osid.id.IdList | list of asset Ids | |
| Errors | INVALID_ARGUMENT | to is less than from | |
| NULL_ARGUMENT | from or to is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetsByTemporalCoverage | ||
| Description |
Gets assets with temporal coverege within the specified dates inclusive. | ||
| Parameters | osid.calendaring.DateTime | from | starting range |
osid.calendaring.DateTime | to | ending range | |
| Return | osid.repository.RepositoryList | list of assets | |
| Errors | INVALID_ARGUMENT | to is less than from | |
| NULL_ARGUMENT | from or to is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |