Interface CompositionRepositorySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CompositionRepositorySession
extends OsidSession

This session provides methods to retrieve Composition to Repository mappings. A Composition 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 several 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	canLookupCompositionRepositoryMappings()	Tests if this user can perform lookups of composition/repository mappings.
IdList	getCompositionIdsByRepositories(IdList repositoryIds)	Gets the list of Composition Ids corresponding to a list of Repository objects
IdList	getCompositionIdsByRepository(Id repositoryId)	Gets the list of Composition Ids associated with a Repository .
CompositionList	getCompositionsByRepositories(IdList repositoryIds)	Gets the list of Compositions corresponding to a list of Repository objects
CompositionList	getCompositionsByRepository(Id repositoryId)	Gets the list of Compositions associated with a Repository .
RepositoryList	getRepositoriesByComposition(Id compositionId)	Gets the Repository objects mapped to a Composition .
IdList	getRepositoryIdsByComposition(Id compositionId)	Gets the Repository Ids mapped to a Composition .
void	useComparativeCompositionRepositoryView()	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	usePlenaryCompositionRepositoryView()	A complete view of the Composition 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

useComparativeCompositionRepositoryView

void useComparativeCompositionRepositoryView()

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.

usePlenaryCompositionRepositoryView

void usePlenaryCompositionRepositoryView()

A complete view of the Composition 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.

canLookupCompositionRepositoryMappings

boolean canLookupCompositionRepositoryMappings()

Tests if this user can perform lookups of composition/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.

getCompositionIdsByRepository

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

Gets the list of Composition Ids associated with a Repository .

Parameters:

repositoryId - Id of the Repository

Returns:

list of related composition 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.

getCompositionsByRepository

CompositionList getCompositionsByRepository(Id repositoryId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Compositions associated with a Repository .

Parameters:

repositoryId - Id of the Repository

Returns:

list of related compositions

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.

getCompositionIdsByRepositories

IdList getCompositionIdsByRepositories(IdList repositoryIds)
                                throws OperationFailedException,
PermissionDeniedException

Gets the list of Composition Ids corresponding to a list of Repository objects

Parameters:

repositoryIds - list of repository Ids

Returns:

list of composition Ids

Throws:

NullArgumentException - repositoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCompositionsByRepositories

CompositionList getCompositionsByRepositories(IdList repositoryIds)
                                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Compositions corresponding to a list of Repository objects

Parameters:

repositoryIds - list of repository Ids

Returns:

list of Compositions

Throws:

NullArgumentException - repositoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRepositoryIdsByComposition

IdList getRepositoryIdsByComposition(Id compositionId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Repository Ids mapped to a Composition .

Parameters:

compositionId - Id of a Composition

Returns:

list of repository Ids

Throws:

NotFoundException - compositionId is not found

NullArgumentException - compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRepositoriesByComposition

RepositoryList getRepositoriesByComposition(Id compositionId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Repository objects mapped to a Composition .

Parameters:

compositionId - Id of a Composition

Returns:

list of repositories

Throws:

NotFoundException - compositionId is not found

NullArgumentException - compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.