Interface | osid.repository.AssetTemporalAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to manage temporal coverage of an asset. | ||
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 | canAssignTemporalCoverage | ||
Description |
Tests if this user can manage 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 temporal management is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addTemporalCoverage | ||
Description |
Adds a temporal coverage to this asset expressed as a range between two date/times. | ||
Parameters | osid.id.Id | assetId | Id of the Asset |
osid.calendaring.DateTime | begin | start date/time | |
osid.calendaring.DateTime | end | end date/time | |
Errors | ALREADY_EXISTS | interval already exists | |
INVALID_ARGUMENT | begin is greater than end | ||
NOT_FOUND | assetId not found | ||
NULL_ARGUMENT | assetId, begin or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization fauilure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeTemporalCoverage | ||
Description |
Removes a temporal range from an asset. | ||
Parameters | osid.id.Id | assetId | Id of the Asset |
osid.calendaring.DateTime | begin | start date/time | |
osid.calendaring.DateTime | end | end date/time | |
Errors | NOT_FOUND | assetId with begin and end not
found | |
NULL_ARGUMENT | assetId, begin or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization fauilure | ||
Compliance | mandatory | This method must be implemented. |