Interface AssetRepositorySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssetRepositorySession
extends OsidSession

This session provides methods to retrieve Assets to Repository mappings. An Asset may appear in multiple Repository objects. Each Repository may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupAssetRepositoryMappings()	Tests if this user can perform lookups of asset/repository mappings.
IdList	getAssetIdsByRepositories(IdList repositoryIds)	Gets the list of Asset Ids corresponding to a list of Repository objects.
IdList	getAssetIdsByRepository(Id repositoryId)	Gets the list of Asset Ids associated with a Repository .
AssetList	getAssetsByRepositories(IdList repositoryIds)	Gets the list of Assets corresponding to a list of Repository objects.
AssetList	getAssetsByRepository(Id repositoryId)	Gets the list of Assets associated with a Repository .
RepositoryList	getRepositoriesByAsset(Id assetId)	Gets the list of Repository objects mapped to an Asset .
IdList	getRepositoryIdsByAsset(Id assetId)	Gets the list of Repository Ids mapped to an Asset .
void	useComparativeRepositoryView()	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	usePlenaryRepositoryView()	A complete view of the Asset and Repository returns is desired.

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

canLookupAssetRepositoryMappings

boolean canLookupAssetRepositoryMappings()

Tests if this user can perform lookups of asset/repository mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRepositoryView

void useComparativeRepositoryView()

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.

usePlenaryRepositoryView

void usePlenaryRepositoryView()

A complete view of the Asset and Repository 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.

Compliance:

mandatory - This method is must be implemented.

getAssetIdsByRepository

IdList getAssetIdsByRepository(Id repositoryId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Asset Ids associated with a Repository .

Parameters:

repositoryId - Id of the Repository

Returns:

list of related asset Ids

Throws:

NotFoundException - repositoryId is not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssetsByRepository

AssetList getAssetsByRepository(Id repositoryId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Assets associated with a Repository .

Parameters:

repositoryId - Id of the Repository

Returns:

list of related assets

Throws:

NotFoundException - repositoryId is not found

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssetIdsByRepositories

IdList getAssetIdsByRepositories(IdList repositoryIds)
                          throws OperationFailedException,
PermissionDeniedException

Gets the list of Asset Ids corresponding to a list of Repository objects.

Parameters:

repositoryIds - list of repository Ids

Returns:

list of asset Ids

Throws:

NullArgumentException - repositoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssetsByRepositories

AssetList getAssetsByRepositories(IdList repositoryIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Assets corresponding to a list of Repository objects.

Parameters:

repositoryIds - list of repository Ids

Returns:

list of assets

Throws:

NullArgumentException - repositoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRepositoryIdsByAsset

IdList getRepositoryIdsByAsset(Id assetId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Repository Ids mapped to an Asset .

Parameters:

assetId - Id of an Asset

Returns:

list of repository Ids

Throws:

NotFoundException - assetId is not found

NullArgumentException - assetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRepositoriesByAsset

RepositoryList getRepositoriesByAsset(Id assetId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Repository objects mapped to an Asset .

Parameters:

assetId - Id of an Asset

Returns:

list of repositories

Throws:

NotFoundException - assetId is not found

NullArgumentException - assetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.