org.osid.recognition

Interface ConferralLookupSession

All Superinterfaces:

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

public interface ConferralLookupSession
extends OsidSession

This session defines methods for retrieving conferrals.

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
• isolated academy view: All conferral methods in this session operate, retrieve and pertain to conferrals defined explicitly in the current academy. Using an isolated view is useful for managing conferrals with the ConferralAdminSession.
• federated academy view: All conferral lookup methods in this session operate, retrieve and pertain to all conferrals defined in this academy and any other academies implicitly available in this academy through academy inheritence.
• effective conferral view: All conferral lookup methods return conferrals where the current dates falls in between the effective dates inclusive.
• any effective conferral view: Conferrals of any effective date are returned.

The methods useFederatedAcademyView() and useIsolatedAcademyView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupConferrals() Tests if this user can lookup conferrals.
Academy	getAcademy() Gets the Academy associated with this session.
Id	getAcademyId() Gets the Academy Id associated with this session.
Conferral	getConferral(Id conferralId) Gets the Conferral specified by its Id.
ConferralList	getConferrals() Gets all conferrals.
ConferralList	getConferralsByConvocation(Id convocationId) Gets a list of all conferrals corresponding to a convocation Id.
ConferralList	getConferralsByConvocationOnDate(Id convocationId, DateTime from, DateTime to) Gets a list of all conferrals corresponding to a convocation Id and effective during the entire given date range inclusive but not confined to the date range.
ConferralList	getConferralsByGenusType(Type conferralGenusType) Gets a ConferralList corresponding to the given conferral genus Type which does not include conferrals of genus types derived from the specified Type.
ConferralList	getConferralsByIds(IdList conferralIds) Gets a ConferralList corresponding to the given IdList.
ConferralList	getConferralsByParentGenusType(Type conferralGenusType) Gets a ConferralList corresponding to the given conferral genus Type and include any additional conferrals with genus types derived from the specified Type.
ConferralList	getConferralsByRecordType(Type conferralRecordType) Gets a ConferralList containing the given conferral record Type.
ConferralList	getConferralsByReference(Id referenceId) Gets a list of conferrals corresponding to a reference Id.
ConferralList	getConferralsByReferenceOnDate(Id referenceId, DateTime from, DateTime to) Gets a list of all conferrals corresponding to a reference Id and effective during the entire given date range inclusive but not confined to the date range.
ConferralList	getConferralsForAward(Id awardId) Gets a list of all conferrals corresponding to an award Id.
ConferralList	getConferralsForAwardOnDate(Id awardId, DateTime from, DateTime to) Gets a list of all conferrals corresponding to an award Id and effective during the entire given date range inclusive but not confined to the date range.
ConferralList	getConferralsForRecipient(Id resourceId) Gets a list of conferrals corresponding to a resource Id.
ConferralList	getConferralsForRecipientAndAward(Id resourceId, Id awardid) Gets a list of conferralsfor the given resource and award.
ConferralList	getConferralsForRecipientAndAwardOnDate(Id resourceId, Id awardid, DateTime from, DateTime to) Gets a list of all conferrals for the given resource, award, and effective during the entire given date range inclusive but not confined to the date range.
ConferralList	getConferralsForRecipientOnDate(Id resourceId, DateTime from, DateTime to) Gets a list of all conferrals corresponding to a resource Id and effective during the entire given date range inclusive but not confined to the date range.
ConferralList	getConferralsOnDate(DateTime from, DateTime to) Gets a list of conferrals effective during the entire given date range inclusive but not confined to the date range.
void	useAnyEffectiveConferralView() All conferrals of any effective dates are returned by all methods in this session.
void	useComparativeConferralView() 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	useEffectiveConferralView() Only conferrals whose effective dates are current are returned by methods in this session.
void	useFederatedAcademyView() Federates the view for methods in this session.
void	useIsolatedAcademyView() Isolates the view for methods in this session.
void	usePlenaryConferralView() A complete view of the Conferral 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

getAcademyId

Id getAcademyId()

Gets the Academy Id associated with this session.

Returns:

the Academy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAcademy

Academy getAcademy()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Academy associated with this session.

Returns:

the academy

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupConferrals

boolean canLookupConferrals()

Tests if this user can lookup conferrals. 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 opt not to offer these operations.

Returns:

false if conferral lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeConferralView

void useComparativeConferralView()

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.

usePlenaryConferralView

void usePlenaryConferralView()

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

useFederatedAcademyView

void useFederatedAcademyView()

Federates the view for methods in this session. A federated view will include conferrals in academies which are children of this academy in the academy hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAcademyView

void useIsolatedAcademyView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveConferralView

void useEffectiveConferralView()

Only conferrals whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveConferralView

void useAnyEffectiveConferralView()

All conferrals of any effective dates are returned by all methods in this session.

Compliance:

mandatory - This method is must be implemented.

getConferral

Conferral getConferral(Id conferralId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets the Conferral specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Conferral may have a different Id than requested, such as the case where a duplicate Id was assigned to a Conferral and retained for compatibility. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

conferralId - the Id of the Conferral to retrieve

Returns:

the returned Conferral

Throws:

NotFoundException - no Conferral found with the given Id

NullArgumentException - conferralId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByIds

ConferralList getConferralsByIds(IdList conferralIds)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets a ConferralList corresponding to the given IdList. In plenary mode, the returned list contains all of the conferrals 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 conferrals may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

conferralIds - the list of Ids to retrieve

Returns:

the returned Conferral list

Throws:

NotFoundException - an Id was not found

NullArgumentException - conferralIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByGenusType

ConferralList getConferralsByGenusType(Type conferralGenusType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a ConferralList corresponding to the given conferral genus Type which does not include conferrals of genus types derived from the specified Type. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

conferralGenusType - a conferral genus type

Returns:

the returned Conferral list

Throws:

NullArgumentException - conferralGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByParentGenusType

ConferralList getConferralsByParentGenusType(Type conferralGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

conferralGenusType - a conferral genus type

Returns:

the returned Conferral list

Throws:

NullArgumentException - conferralGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByRecordType

ConferralList getConferralsByRecordType(Type conferralRecordType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a ConferralList containing the given conferral record Type. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

conferralRecordType - a conferral record type

Returns:

the returned Conferral list

Throws:

NullArgumentException - conferralRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsOnDate

ConferralList getConferralsOnDate(DateTime from,
                                DateTime to)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets a list of conferrals effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

from - the starting date

to - the ending date

Returns:

the returned ConferralList

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsForRecipient

ConferralList getConferralsForRecipient(Id resourceId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a list of conferrals corresponding to a resource Id. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

resourceId - the Id of the resource

Returns:

the returned ConferralList

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsForRecipientOnDate

ConferralList getConferralsForRecipientOnDate(Id resourceId,
                                            DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a list of all conferrals corresponding to a resource Id and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - from date

to - to date

Returns:

the returned ConferralList

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - resourceId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsForAward

ConferralList getConferralsForAward(Id awardId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a list of all conferrals corresponding to an award Id. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

awardId - the Id of the award

Returns:

the returned ConferralList

Throws:

NullArgumentException - awardId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsForAwardOnDate

ConferralList getConferralsForAwardOnDate(Id awardId,
                                        DateTime from,
                                        DateTime to)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a list of all conferrals corresponding to an award Id and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

awardId - an award Id

from - from date

to - to date

Returns:

the returned ConferralList

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - awardId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsForRecipientAndAward

ConferralList getConferralsForRecipientAndAward(Id resourceId,
                                              Id awardid)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a list of conferralsfor the given resource and award. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

resourceId - the Id of the resource

awardid - the Id of the award

Returns:

the returned ConferralList

Throws:

NullArgumentException - resourceId or awardId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsForRecipientAndAwardOnDate

ConferralList getConferralsForRecipientAndAwardOnDate(Id resourceId,
                                                    Id awardid,
                                                    DateTime from,
                                                    DateTime to)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a list of all conferrals for the given resource, award, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

resourceId - a resource Id

awardid - an award Id

from - from date

to - to date

Returns:

the returned ConferralList

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - resourceId, awardid, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByReference

ConferralList getConferralsByReference(Id referenceId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of conferrals corresponding to a reference Id. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

referenceId - the Id of the reference

Returns:

the returned ConferralList

Throws:

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByReferenceOnDate

ConferralList getConferralsByReferenceOnDate(Id referenceId,
                                           DateTime from,
                                           DateTime to)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets a list of all conferrals corresponding to a reference Id and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

referenceId - a reference Id

from - from date

to - to date

Returns:

the returned ConferralList

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - referenceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByConvocation

ConferralList getConferralsByConvocation(Id convocationId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a list of all conferrals corresponding to a convocation Id. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

convocationId - the Id of the convocation

Returns:

the returned ConferralList

Throws:

NullArgumentException - convocationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralsByConvocationOnDate

ConferralList getConferralsByConvocationOnDate(Id convocationId,
                                             DateTime from,
                                             DateTime to)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets a list of all conferrals corresponding to a convocation Id and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Parameters:

convocationId - a convocation Id

from - from date

to - to date

Returns:

the returned ConferralList

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - convocationId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferrals

ConferralList getConferrals()
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets all conferrals. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.

Returns:

a list of conferrals

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.