Interface AssetTemporalAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssetTemporalAssignmentSession
extends OsidSession

This session defines methods to manage temporal coverage of an asset.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                  throws OperationFailedException,
PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the Repository associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignTemporalCoverage

boolean canAssignTemporalCoverage()

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 PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations.

Returns:

false if temporal management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addTemporalCoverage

void addTemporalCoverage(Id assetId,
 DateTime begin,
 DateTime end)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a temporal coverage to this asset expressed as a range between two date/times.

Parameters:

assetId - Id of the Asset

begin - start date/time

end - end date/time

Throws:

AlreadyExistsException - interval already exists

InvalidArgumentException - begin is greater than end

NotFoundException - assetId not found

NullArgumentException - assetId, begin or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

removeTemporalCoverage

void removeTemporalCoverage(Id assetId,
 DateTime begin,
 DateTime end)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a temporal range from an asset.

Parameters:

assetId - Id of the Asset

begin - start date/time

end - end date/time

Throws:

NotFoundException - assetId with begin and end not found

NullArgumentException - assetId, begin or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.