public interface AssetTemporalSession extends OsidSession
This session defines a means for accessing temporal coverage of an
asset. The views sorrespond to the view defined in the
AssetLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTemporalCoverage()
Tests if this user can perform temporal lookups.
|
IdList |
getAssetIdsByTemporalCoverage(DateTime from,
DateTime to)
Gets asset
Ids with temporal coverege within the
specified dates inclusive. |
RepositoryList |
getAssetsByTemporalCoverage(DateTime from,
DateTime to)
Gets assets with temporal coverege within the specified dates
inclusive.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
DateTimeIntervalList |
getTemporalCoverage(Id assetId)
Gets the temporal coverage related to the subject of this asset.
|
void |
useComparativeAssetView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
void |
usePlenaryAssetView()
A complete view of the
Asset returns is desired. |
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 canLookupTemporalCoverage()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if lookups are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAssetView()
mandatory
- This method is must be implemented. void usePlenaryAssetView()
Asset
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. DateTimeIntervalList getTemporalCoverage(Id assetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
to queryNotFoundException
- assetId
is not foundNullArgumentException
- assetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAssetIdsByTemporalCoverage(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Ids
with temporal coverege within the
specified dates inclusive.from
- starting rangeto
- ending range Ids
InvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RepositoryList getAssetsByTemporalCoverage(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- starting rangeto
- ending rangeInvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.