Interface ParticipantCatalogueSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ParticipantCatalogueSession
extends OsidSession

This session provides methods to retrieve Participant to Catalogue mappings. A Participant may appear in multiple Catalogues . Each Catalogue 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	canLookupParticipantCatalogueMappings()	Tests if this user can perform lookups of participant/catalogue mappings.
IdList	getCatalogueIdsByParticipant(Id participantId)	Gets the list of Catalogue Ids mapped to a Participant .
CatalogueList	getCataloguesByParticipant(Id participantId)	Gets the list of Catalogue objects mapped to a Participant .
IdList	getParticipantIdsByCatalogue(Id catalogueId)	Gets the list of participant Ids associated with a Catalogue .
IdList	getParticipantIdsByCatalogues(IdList catalogueIds)	Gets the list of Participant Ids corresponding to a list of Catalogue objects.
ParticipantList	getParticipantsByCatalogue(Id catalogueId)	Gets the list of Participants associated with a Catalogue .
ParticipantList	getParticipantsByCatalogues(IdList catalogueIds)	Gets the list of Participants corresponding to a list of Catalogues .
void	useComparativeCatalogueView()	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	usePlenaryCatalogueView()	A complete view of the Participant and Catalogue 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

canLookupParticipantCatalogueMappings

boolean canLookupParticipantCatalogueMappings()

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

useComparativeCatalogueView

void useComparativeCatalogueView()

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.

usePlenaryCatalogueView

void usePlenaryCatalogueView()

A complete view of the Participant and Catalogue 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.

getParticipantIdsByCatalogue

IdList getParticipantIdsByCatalogue(Id catalogueId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of participant Ids associated with a Catalogue .

Parameters:

catalogueId - Id of a Catalogues .

Returns:

list of related participant Ids

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByCatalogue

ParticipantList getParticipantsByCatalogue(Id catalogueId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Participants associated with a Catalogue .

Parameters:

catalogueId - Id of a Catalogue

Returns:

list of related participants

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantIdsByCatalogues

IdList getParticipantIdsByCatalogues(IdList catalogueIds)
                              throws OperationFailedException,
PermissionDeniedException

Gets the list of Participant Ids corresponding to a list of Catalogue objects.

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of participant Ids

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByCatalogues

ParticipantList getParticipantsByCatalogues(IdList catalogueIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Participants corresponding to a list of Catalogues .

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of participants

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueIdsByParticipant

IdList getCatalogueIdsByParticipant(Id participantId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Catalogue Ids mapped to a Participant .

Parameters:

participantId - Id of a Participant

Returns:

list of catalogue Ids

Throws:

NotFoundException - participantId is not found

NullArgumentException - participantId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCataloguesByParticipant

CatalogueList getCataloguesByParticipant(Id participantId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Catalogue objects mapped to a Participant .

Parameters:

participantId - Id of a Participant

Returns:

list of catalogues

Throws:

NotFoundException - participantId is not found

NullArgumentException - participantId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.