public interface AssetTemporalAssignmentSession extends OsidSession
This session defines methods to manage temporal coverage of an asset.
Modifier and Type | Method and Description |
---|---|
void |
addTemporalCoverage(Id assetId,
DateTime begin,
DateTime end)
Adds a temporal coverage to this asset expressed as a range between
two date/times.
|
boolean |
canAssignTemporalCoverage()
Tests if this user can manage temporal lookups.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
removeTemporalCoverage(Id assetId,
DateTime begin,
DateTime end)
Removes a temporal range from an asset.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session. Repository
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignTemporalCoverage()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer assignment operations. false
if temporal management is not authorized,
true
otherwisemandatory
- This method must be implemented. void addTemporalCoverage(Id assetId, DateTime begin, DateTime end) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
begin
- start date/timeend
- end date/timeAlreadyExistsException
- interval already existsInvalidArgumentException
- begin
is
greater than end
NotFoundException
- assetId
not
found
NullArgumentException
- assetId, begin
or end
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented. void removeTemporalCoverage(Id assetId, DateTime begin, DateTime end) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
begin
- start date/timeend
- end date/timeNotFoundException
- assetId
with
begin
and end
not found
NullArgumentException
- assetId, begin
or end
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented.