org.osid.recognition

Interface AcademyLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AcademyLookupSession
extends OsidSession

This session provides methods for retrieving Academy objects. The Academy represents a collection of conferrals, awards, and convocations.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAcademies() Tests if this user can perform Academy lookups.
AcademyList	getAcademies() Gets all Academies.
AcademyList	getAcademiesByGenusType(Type academyGenusType) Gets an AcademyList corresponding to the given academy genus Type which does not include academies of genus types derived from the specified Type.
AcademyList	getAcademiesByIds(IdList academyIds) Gets an AcademyList corresponding to the given IdList.
AcademyList	getAcademiesByParentGenusType(Type academyGenusType) Gets an AcademyList corresponding to the given academy genus Type and include any additional academies with genus types derived from the specified Type.
AcademyList	getAcademiesByProvider(Id resourceId) Gets an AcademyList by the given provdier .
AcademyList	getAcademiesByRecordType(Type academyRecordType) Gets an AcademyList containing the given academy record Type.
Academy	getAcademy(Id jouralId) Gets the Academy specified by its Id.
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 Academy returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupAcademies

boolean canLookupAcademies()

Tests if this user can perform Academy 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 not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are 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 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.

getAcademy

Academy getAcademy(Id jouralId)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Gets the Academy specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Academy may have a different Id than requested, such as the case where a duplicate Id was assigned to an Academy and retained for compatibility.

Parameters:

jouralId - Id of the Academy

Returns:

the academy

Throws:

NotFoundException - academyId not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getAcademiesByIds

AcademyList getAcademiesByIds(IdList academyIds)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets an AcademyList corresponding to the given IdList. In plenary mode, the returned list contains all of the academies specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Academies may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

academyIds - the list of Ids to retrieve

Returns:

the returned Academy list

Throws:

NotFoundException - an Id was not found

NullArgumentException - academyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademiesByGenusType

AcademyList getAcademiesByGenusType(Type academyGenusType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets an AcademyList corresponding to the given academy genus Type which does not include academies of genus types derived from the specified Type. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parameters:

academyGenusType - an academy genus type

Returns:

the returned Academy list

Throws:

NullArgumentException - academyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademiesByParentGenusType

AcademyList getAcademiesByParentGenusType(Type academyGenusType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets an AcademyList corresponding to the given academy genus Type and include any additional academies with genus types derived from the specified Type. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parameters:

academyGenusType - an academy genus type

Returns:

the returned Academy list

Throws:

NullArgumentException - academyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademiesByRecordType

AcademyList getAcademiesByRecordType(Type academyRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets an AcademyList containing the given academy record Type. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parameters:

academyRecordType - an academy record type

Returns:

the returned Academy list

Throws:

NullArgumentException - academyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademiesByProvider

AcademyList getAcademiesByProvider(Id resourceId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets an AcademyList by the given provdier . In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Academy list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAcademies

AcademyList getAcademies()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets all Academies. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Returns:

a list of Academies

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.