Interface ConvocationAcademySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ConvocationAcademySession
extends OsidSession

This session provides methods to retrieve Convocation to Academy mappings. A Convocation may appear in multiple Academies . Each Academy 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	canLookupConvocationAcademyMappings()	Tests if this user can perform lookups of convocation/academy mappings.
AcademyList	getAcademiesByConvocation(Id convocationId)	Gets the list of Academy objects mapped to a Convocation .
IdList	getAcademyIdsByConvocation(Id convocationId)	Gets the list of Academy Ids mapped to a Convocation .
IdList	getConvocationIdsByAcademies(IdList academyIds)	Gets the list of Convocation Ids corresponding to a list of Academy objects.
IdList	getConvocationIdsByAcademy(Id academyId)	Gets the list of Convocation Ids associated with an Academy .
ConvocationList	getConvocationsByAcademies(IdList academyIds)	Gets the list of Convocations corresponding to a list of Academies .
ConvocationList	getConvocationsByAcademy(Id academyId)	Gets the list of Convocations associated with an Academy .
void	useComparativeAcademyView()	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	usePlenaryAcademyView()	A complete view of the Convocation and Academy 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

canLookupConvocationAcademyMappings

boolean canLookupConvocationAcademyMappings()

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

useComparativeAcademyView

void useComparativeAcademyView()

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.

usePlenaryAcademyView

void usePlenaryAcademyView()

A complete view of the Convocation and Academy 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.

getConvocationIdsByAcademy

IdList getConvocationIdsByAcademy(Id academyId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Convocation Ids associated with an Academy .

Parameters:

academyId - Id of an Academy .

Returns:

list of related convocation Ids

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConvocationsByAcademy

ConvocationList getConvocationsByAcademy(Id academyId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Convocations associated with an Academy .

Parameters:

academyId - Id of an Academy

Returns:

list of related convocations

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConvocationIdsByAcademies

IdList getConvocationIdsByAcademies(IdList academyIds)
                             throws OperationFailedException,
PermissionDeniedException

Gets the list of Convocation Ids corresponding to a list of Academy objects.

Parameters:

academyIds - list of academy Ids

Returns:

list of convocation Ids

Throws:

NullArgumentException - academyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConvocationsByAcademies

ConvocationList getConvocationsByAcademies(IdList academyIds)
                                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Convocations corresponding to a list of Academies .

Parameters:

academyIds - list of academy Ids

Returns:

list of convocations

Throws:

NullArgumentException - academyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademyIdsByConvocation

IdList getAcademyIdsByConvocation(Id convocationId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Academy Ids mapped to a Convocation .

Parameters:

convocationId - Id of a Convocation

Returns:

list of academy Ids

Throws:

NotFoundException - convocationId is not found

NullArgumentException - convocationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademiesByConvocation

AcademyList getAcademiesByConvocation(Id convocationId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Academy objects mapped to a Convocation .

Parameters:

convocationId - Id of a Convocation

Returns:

list of academies

Throws:

NotFoundException - convocationId is not found

NullArgumentException - convocationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.