Interface RecognitionManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, RecognitionProfile, Sourceable

public interface RecognitionManager
extends OsidManager, RecognitionProfile

The recognition manager provides access to conferral sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ConferralLookupSession : a session to lookup conferrals
• ConferralQuerySession : a session to query conferrals
• ConferralSearchSession : a session to search conferrals
• ConferralAdminSession : a session to manage conferrals
• ConferralNotificationSession : a session to subscribe to notifications of conferral changes
• ConferralAcademySession : a session to lookup conferral academy mappings
• ConferralAcademyAssignmentSession : a session to manage conferral academy mappings
• ConferralSmartAcademySession : a session to manage smart academies of conferrals
• AwardLookupSession : a session to retrieve awards
• AwardQuerySession : a session to query awards
• AwardSearchSession : a session to search for awards
• AwardAdminSession : a session to create, update and delete awards
• AwardNotificationSession : a session to receive notifications for changes in awards
• AwardAcademySession : a session to lookup award academy mappings
• AwardAcademyAssignmentSession : a session to manage award academy mappings
• AwardSmartAcademySession : a session to manage smart academies of awards

• ConvocationSession : a session to get available convocations for a resource
• ConvocationLookupSession : a session to lookup convocations
• ConvocationQuerySession : a session to query convocations
• ConvocationSearchSession : a session to search convocations
• ConvocationAdminSession : a session to manage convocations
• ConvocationNotificationSession : a session to subscribe to notifications of convocation changes
• ConvocationAcademySession : a session to lookup convocation academy mappings
• ConvocationAcademyAssignmentSession : a session to manage convocation academy mappings
• ConvocationSmartAcademySession : a session to manage smart academies of convocations

• AcademyLookupSession : a session to retrieve academies
• AcademyQuerySession : a session to query academies
• AcademySearchSession : a session to search for academies
• AcademyAdminSession : a session to create, update and delete academies
• AcademyNotificationSession : a session to receive notifications for changes in academies
• AcademyHierarchyTraversalSession : a session to traverse hierarchies of academies
• AcademyHierarchyDesignSession : a session to manage hierarchies of academies

The recognition manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Modifier and Type	Method	Description
AcademyAdminSession	getAcademyAdminSession()	Gets the OsidSession associated with the academy administrative service.
AcademyHierarchyDesignSession	getAcademyHierarchyDesignSession()	Gets the OsidSession associated with the academy hierarchy design service.
AcademyHierarchySession	getAcademyHierarchySession()	Gets the OsidSession associated with the academy hierarchy service.
AcademyLookupSession	getAcademyLookupSession()	Gets the OsidSession associated with the academy lookup service.
AcademyNotificationSession	getAcademyNotificationSession(AcademyReceiver academyReceiver)	Gets the OsidSession associated with the academy notification service.
AcademyQuerySession	getAcademyQuerySession()	Gets the OsidSession associated with the academy query service.
AcademySearchSession	getAcademySearchSession()	Gets the OsidSession associated with the academy search service.
AwardAcademyAssignmentSession	getAwardAcademyAssignmentSession()	Gets the session for assigning award to academy mappings.
AwardAcademySession	getAwardAcademySession()	Gets the session for retrieving award to academy mappings.
AwardAdminSession	getAwardAdminSession()	Gets the OsidSession associated with the award administrative service.
AwardAdminSession	getAwardAdminSessionForAcademy(Id academyId)	Gets the OsidSession associated with the award administrative service for the given academy.
AwardLookupSession	getAwardLookupSession()	Gets the OsidSession associated with the award lookup service.
AwardLookupSession	getAwardLookupSessionForAcademy(Id academyId)	Gets the OsidSession associated with the award lookup service for the given academy.
AwardNotificationSession	getAwardNotificationSession(AwardReceiver awardReceiver)	Gets the OsidSession associated with the award notification service.
AwardNotificationSession	getAwardNotificationSessionForAcademy(AwardReceiver awardReceiver, Id academyId)	Gets the OsidSession associated with the award notification service for the given academy.
AwardQuerySession	getAwardQuerySession()	Gets the OsidSession associated with the award query service.
AwardQuerySession	getAwardQuerySessionForAcademy(Id academyId)	Gets the OsidSession associated with the award query service for the given academy.
AwardSearchSession	getAwardSearchSession()	Gets the OsidSession associated with the award search service.
AwardSearchSession	getAwardSearchSessionForAcademy(Id academyId)	Gets the OsidSession associated with the award search service for the given academy.
AwardSmartAcademySession	getAwardSmartAcademySession(Id academyId)	Gets the session associated with the award smart academy for the given academy.
ConferralAcademyAssignmentSession	getConferralAcademyAssignmentSession()	Gets the session for assigning conferral to academy mappings.
ConferralAcademySession	getConferralAcademySession()	Gets the session for retrieving conferral to academy mappings.
ConferralAdminSession	getConferralAdminSession()	Gets the OsidSession associated with the conferral administration service.
ConferralAdminSession	getConferralAdminSessionForAcademy(Id academyId)	Gets the OsidSession associated with the conferral administration service for the given academy.
ConferralLookupSession	getConferralLookupSession()	Gets the OsidSession associated with the conferral lookup service.
ConferralLookupSession	getConferralLookupSessionForAcademy(Id academyId)	Gets the OsidSession associated with the conferral lookup service for the given academy.
ConferralNotificationSession	getConferralNotificationSession(ConferralReceiver conferralReceiver)	Gets the OsidSession associated with the conferral notification service.
ConferralNotificationSession	getConferralNotificationSessionForAcademy(ConferralReceiver conferralReceiver, Id academyId)	Gets the OsidSession associated with the conferral notification service for the given academy.
ConferralQuerySession	getConferralQuerySession()	Gets the OsidSession associated with the conferral query service.
ConferralQuerySession	getConferralQuerySessionForAcademy(Id academyId)	Gets the OsidSession associated with the conferral query service for the given academy.
ConferralSearchSession	getConferralSearchSession()	Gets the OsidSession associated with the conferral search service.
ConferralSearchSession	getConferralSearchSessionForAcademy(Id academyId)	Gets the OsidSession associated with the conferral search service for the given academy.
ConferralSmartAcademySession	getConferralSmartAcademySession(Id academyId)	Gets the session associated with the conferral smart academy for the given academy.
ConvocationAcademyAssignmentSession	getConvocationAcademyAssignmentSession()	Gets the session for assigning convocation to academy mappings.
ConvocationAcademySession	getConvocationAcademySession()	Gets the session for retrieving convocation to academy mappings.
ConvocationAdminSession	getConvocationAdminSession()	Gets the OsidSession associated with the convocation administration service.
ConvocationAdminSession	getConvocationAdminSessionForAcademy(Id academyId)	Gets the OsidSession associated with the convocation administration service for the given academy.
ConvocationLookupSession	getConvocationLookupSession()	Gets the OsidSession associated with the convocation lookup service.
ConvocationLookupSession	getConvocationLookupSessionForAcademy(Id academyId)	Gets the OsidSession associated with the convocation lookup service for the given academy.
ConvocationNotificationSession	getConvocationNotificationSession(ConvocationReceiver convocationReceiver)	Gets the OsidSession associated with the convocation notification service.
ConvocationNotificationSession	getConvocationNotificationSessionForAcademy(ConvocationReceiver convocationReceiver, Id academyId)	Gets the OsidSession associated with the convocation notification service for the given academy.
ConvocationQuerySession	getConvocationQuerySession()	Gets the OsidSession associated with the convocation query service.
ConvocationQuerySession	getConvocationQuerySessionForAcademy(Id academyId)	Gets the OsidSession associated with the convocation query service for the given academy.
ConvocationSearchSession	getConvocationSearchSession()	Gets the OsidSession associated with the convocation search service.
ConvocationSearchSession	getConvocationSearchSessionForAcademy(Id academyId)	Gets the OsidSession associated with the convocation search service for the given academy.
ConvocationSmartAcademySession	getConvocationSmartAcademySession(Id academyId)	Gets the session associated with the convocation smart academy for the given academy.
RecognitionBatchManager	getRecognitionBatchManager()	Gets a RecognitionBatchManager .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface RecognitionProfile

getAcademyRecordTypes, getAcademySearchRecordTypes, getAwardRecordTypes, getAwardSearchRecordTypes, getConferralRecordTypes, getConferralSearchRecordTypes, getConvocationRecordTypes, getConvocationSearchRecordTypes, supportsAcademyAdmin, supportsAcademyHierarchy, supportsAcademyHierarchyDesign, supportsAcademyLookup, supportsAcademyNotification, supportsAcademyQuery, supportsAcademyRecordType, supportsAcademySearch, supportsAcademySearchRecordType, supportsAwardAcademy, supportsAwardAcademyAssignment, supportsAwardAdmin, supportsAwardLookup, supportsAwardNotification, supportsAwardQuery, supportsAwardRecordType, supportsAwardSearch, supportsAwardSearchRecordType, supportsAwardSmartAcademy, supportsConferralAcademy, supportsConferralAcademyAssignment, supportsConferralAdmin, supportsConferralLookup, supportsConferralNotification, supportsConferralQuery, supportsConferralRecordType, supportsConferralSearch, supportsConferralSearchRecordType, supportsConferralSmartAcademy, supportsConvocation, supportsConvocationAcademy, supportsConvocationAcademyAssignment, supportsConvocationAdmin, supportsConvocationLookup, supportsConvocationNotification, supportsConvocationQuery, supportsConvocationRecordType, supportsConvocationSearch, supportsConvocationSearchRecordType, supportsConvocationSmartAcademy, supportsRecognitionBatch, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAcademyRecordTypes()	Gets the supported academy record types.
TypeList	getAcademySearchRecordTypes()	Gets the supported academy search record types.
TypeList	getAwardRecordTypes()	Gets the supported Award record types.
TypeList	getAwardSearchRecordTypes()	Gets the supported award search record types.
TypeList	getConferralRecordTypes()	Gets the supported Conferral record types.
TypeList	getConferralSearchRecordTypes()	Gets the supported conferral search record types.
TypeList	getConvocationRecordTypes()	Gets the supported Convocation record types.
TypeList	getConvocationSearchRecordTypes()	Gets the supported convocation search record types.
boolean	supportsAcademyAdmin()	Tests for the availability of an academy administrative service for creating and deleting academies.
boolean	supportsAcademyHierarchy()	Tests for the availability of an academy hierarchy traversal service.
boolean	supportsAcademyHierarchyDesign()	Tests for the availability of an academy hierarchy design service.
boolean	supportsAcademyLookup()	Tests for the availability of an academy lookup service.
boolean	supportsAcademyNotification()	Tests for the availability of an academy notification service.
boolean	supportsAcademyQuery()	Tests if querying academies is available.
boolean	supportsAcademyRecordType(Type academyRecordType)	Tests if the given academy record type is supported.
boolean	supportsAcademySearch()	Tests if searching for academies is available.
boolean	supportsAcademySearchRecordType(Type academySearchRecordType)	Tests if the given academy search record type is supported.
boolean	supportsAwardAcademy()	Tests if an award to academy lookup session is available.
boolean	supportsAwardAcademyAssignment()	Tests if an award to academy assignment session is available.
boolean	supportsAwardAdmin()	Tests for the availability of an award administrative service for creating and deleting awards.
boolean	supportsAwardLookup()	Tests for the availability of an award lookup service.
boolean	supportsAwardNotification()	Tests for the availability of an award notification service.
boolean	supportsAwardQuery()	Tests if querying awards is available.
boolean	supportsAwardRecordType(Type awardRecordType)	Tests if the given Award record type is supported.
boolean	supportsAwardSearch()	Tests if searching for awards is available.
boolean	supportsAwardSearchRecordType(Type awardSearchRecordType)	Tests if the given award search record type is supported.
boolean	supportsAwardSmartAcademy()	Tests if an award smart academy session is available.
boolean	supportsConferralAcademy()	Tests if a conferral to academy lookup session is available.
boolean	supportsConferralAcademyAssignment()	Tests if a conferral to academy assignment session is available.
boolean	supportsConferralAdmin()	Tests if searching for conferrals is available.
boolean	supportsConferralLookup()	Tests for the availability of a conferral lookup service.
boolean	supportsConferralNotification()	Tests if conferral notification is available.
boolean	supportsConferralQuery()	Tests if querying conferrals is available.
boolean	supportsConferralRecordType(Type conferralRecordType)	Tests if the given Conferral record type is supported.
boolean	supportsConferralSearch()	Tests if searching for conferrals is available.
boolean	supportsConferralSearchRecordType(Type conferralSearchRecordType)	Tests if the given conferral search record type is supported.
boolean	supportsConferralSmartAcademy()	Tests if a conferral smart academy session is available.
boolean	supportsConvocation()	Tests for the availability of a convocation service for getting available convocations for a resource.
boolean	supportsConvocationAcademy()	Tests if a convocation to academy lookup session is available.
boolean	supportsConvocationAcademyAssignment()	Tests if a convocation to academy assignment session is available.
boolean	supportsConvocationAdmin()	Tests if searching for convocations is available.
boolean	supportsConvocationLookup()	Tests for the availability of a convocation lookup service.
boolean	supportsConvocationNotification()	Tests if convocation notification is available.
boolean	supportsConvocationQuery()	Tests if querying convocations is available.
boolean	supportsConvocationRecordType(Type convocationRecordType)	Tests if the given Convocation record type is supported.
boolean	supportsConvocationSearch()	Tests if searching for convocations is available.
boolean	supportsConvocationSearchRecordType(Type convocationSearchRecordType)	Tests if the given convocation search record type is supported.
boolean	supportsConvocationSmartAcademy()	Tests if a convocation smart academy session is available.
boolean	supportsRecognitionBatch()	Tests for the availability of a recognition batch service.
boolean	supportsVisibleFederation()	Tests if any award federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getConferralLookupSession

ConferralLookupSession getConferralLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the conferral lookup service.

Returns:

a ConferralLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralLookup()} is {@code true} .

getConferralLookupSessionForAcademy

ConferralLookupSession getConferralLookupSessionForAcademy(Id academyId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the conferral lookup service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConferralLookupSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralLookup()} and {@code supportsVisibleFederation()} are {@code true}

getConferralQuerySession

ConferralQuerySession getConferralQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the conferral query service.

Returns:

a ConferralQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralQuery()} is {@code true} .

getConferralQuerySessionForAcademy

ConferralQuerySession getConferralQuerySessionForAcademy(Id academyId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the conferral query service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConferralQuerySession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralQuery()} and {@code supportsVisibleFederation()} are {@code true}

getConferralSearchSession

ConferralSearchSession getConferralSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the conferral search service.

Returns:

a ConferralSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralSearch()} is {@code true} .

getConferralSearchSessionForAcademy

ConferralSearchSession getConferralSearchSessionForAcademy(Id academyId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the conferral search service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConferralSearchSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralSearch()} and {@code supportsVisibleFederation()} are {@code true}

getConferralAdminSession

ConferralAdminSession getConferralAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the conferral administration service.

Returns:

a ConferralAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralAdmin()} is {@code true} .

getConferralAdminSessionForAcademy

ConferralAdminSession getConferralAdminSessionForAcademy(Id academyId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the conferral administration service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConferralAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getConferralNotificationSession

ConferralNotificationSession getConferralNotificationSession(ConferralReceiver conferralReceiver)
                                                      throws OperationFailedException

Gets the OsidSession associated with the conferral notification service.

Parameters:

conferralReceiver - the receiver

Returns:

a ConferralNotificationSession

Throws:

NullArgumentException - conferralReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralNotification()} is {@code true} .

getConferralNotificationSessionForAcademy

ConferralNotificationSession getConferralNotificationSessionForAcademy(ConferralReceiver conferralReceiver,
 Id academyId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the conferral notification service for the given academy.

Parameters:

conferralReceiver - the receiver

academyId - the Id of the Academy

Returns:

a ConferralNotificationSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - conferralReceiver or academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralNotification()} and {@code supportsVisibleFederation()} are {@code true}

getConferralAcademySession

ConferralAcademySession getConferralAcademySession()
                                            throws OperationFailedException

Gets the session for retrieving conferral to academy mappings.

Returns:

a ConferralAcademySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralAcademy() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralAcademy()} is {@code true} .

getConferralAcademyAssignmentSession

ConferralAcademyAssignmentSession getConferralAcademyAssignmentSession()
                                                                throws OperationFailedException

Gets the session for assigning conferral to academy mappings.

Returns:

a ConferralAcademyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralAcademyAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralAcademyAssignment()} is {@code true} .

getConferralSmartAcademySession

ConferralSmartAcademySession getConferralSmartAcademySession(Id academyId)
                                                      throws NotFoundException,
OperationFailedException

Gets the session associated with the conferral smart academy for the given academy.

Parameters:

academyId - the Id of the academy

Returns:

a ConferralSmartAcademySession

Throws:

NotFoundException - conferralBookId not found

NullArgumentException - conferralBookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralSmartAcademy() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralSmartAcademy()} is {@code true} .

getAwardLookupSession

AwardLookupSession getAwardLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the award lookup service.

Returns:

an AwardLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardLookup()} is {@code true} .

getAwardLookupSessionForAcademy

AwardLookupSession getAwardLookupSessionForAcademy(Id academyId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the award lookup service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

an AwardLookupSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardLookup()} and {@code supportsVisibleFederation()} are {@code true}

getAwardQuerySession

AwardQuerySession getAwardQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the award query service.

Returns:

an AwardQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardQuery()} is {@code true} .

getAwardQuerySessionForAcademy

AwardQuerySession getAwardQuerySessionForAcademy(Id academyId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the award query service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

an AwardQuerySession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardQuery()} and {@code supportsVisibleFederation()} are {@code true}

getAwardSearchSession

AwardSearchSession getAwardSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the award search service.

Returns:

an AwardSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardSearch()} is {@code true} .

getAwardSearchSessionForAcademy

AwardSearchSession getAwardSearchSessionForAcademy(Id academyId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the award search service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

an AwardSearchSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardSearch()} and {@code supportsVisibleFederation()} are {@code true}

getAwardAdminSession

AwardAdminSession getAwardAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the award administrative service.

Returns:

an AwardAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardAdmin()} is {@code true} .

getAwardAdminSessionForAcademy

AwardAdminSession getAwardAdminSessionForAcademy(Id academyId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the award administrative service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

an AwardAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAwardNotificationSession

AwardNotificationSession getAwardNotificationSession(AwardReceiver awardReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the award notification service.

Parameters:

awardReceiver - the receiver

Returns:

an AwardNotificationSession

Throws:

NullArgumentException - awardReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardNotification()} is {@code true} .

getAwardNotificationSessionForAcademy

AwardNotificationSession getAwardNotificationSessionForAcademy(AwardReceiver awardReceiver,
 Id academyId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the award notification service for the given academy.

Parameters:

awardReceiver - the receiver

academyId - the Id of the Academy

Returns:

an AwardNotificationSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - awardReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardNotification()} and {@code supportsVisibleFederation()} are {@code true}

getAwardAcademySession

AwardAcademySession getAwardAcademySession()
                                    throws OperationFailedException

Gets the session for retrieving award to academy mappings.

Returns:

an AwardAcademySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardAcademy() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardAcademy()} is {@code true} .

getAwardAcademyAssignmentSession

AwardAcademyAssignmentSession getAwardAcademyAssignmentSession()
                                                        throws OperationFailedException

Gets the session for assigning award to academy mappings.

Returns:

an AwardAcademyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardAcademyAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardAcademyAssignment()} is {@code true} .

getAwardSmartAcademySession

AwardSmartAcademySession getAwardSmartAcademySession(Id academyId)
                                              throws NotFoundException,
OperationFailedException

Gets the session associated with the award smart academy for the given academy.

Parameters:

academyId - the Id of the academy

Returns:

an AwardSmartAcademySession

Throws:

NotFoundException - academyId not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardSmartAcademy() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardSmartAcademy()} is {@code true} .

getConvocationLookupSession

ConvocationLookupSession getConvocationLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the convocation lookup service.

Returns:

a ConvocationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationLookup()} is {@code true} .

getConvocationLookupSessionForAcademy

ConvocationLookupSession getConvocationLookupSessionForAcademy(Id academyId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the convocation lookup service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConvocationLookupSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationLookup()} and {@code supportsVisibleFederation()} are {@code true}

getConvocationQuerySession

ConvocationQuerySession getConvocationQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the convocation query service.

Returns:

a ConvocationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationQuery()} is {@code true} .

getConvocationQuerySessionForAcademy

ConvocationQuerySession getConvocationQuerySessionForAcademy(Id academyId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the convocation query service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConvocationQuerySession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationQuery()} and {@code supportsVisibleFederation()} are {@code true}

getConvocationSearchSession

ConvocationSearchSession getConvocationSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the convocation search service.

Returns:

a ConvocationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationSearch()} is {@code true} .

getConvocationSearchSessionForAcademy

ConvocationSearchSession getConvocationSearchSessionForAcademy(Id academyId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the convocation search service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConvocationSearchSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationSearch()} and {@code supportsVisibleFederation()} are {@code true}

getConvocationAdminSession

ConvocationAdminSession getConvocationAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the convocation administration service.

Returns:

a ConvocationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationAdmin()} is {@code true} .

getConvocationAdminSessionForAcademy

ConvocationAdminSession getConvocationAdminSessionForAcademy(Id academyId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the convocation administration service for the given academy.

Parameters:

academyId - the Id of the Academy

Returns:

a ConvocationAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getConvocationNotificationSession

ConvocationNotificationSession getConvocationNotificationSession(ConvocationReceiver convocationReceiver)
                                                          throws OperationFailedException

Gets the OsidSession associated with the convocation notification service.

Parameters:

convocationReceiver - the receiver

Returns:

a ConvocationNotificationSession

Throws:

NullArgumentException - convocationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationNotification()} is {@code true} .

getConvocationNotificationSessionForAcademy

ConvocationNotificationSession getConvocationNotificationSessionForAcademy(ConvocationReceiver convocationReceiver,
 Id academyId)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the convocation notification service for the given academy.

Parameters:

convocationReceiver - the receiver

academyId - the Id of the Academy

Returns:

a ConvocationNotificationSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - convocationReceiver or academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationNotification()} and {@code supportsVisibleFederation()} are {@code true}

getConvocationAcademySession

ConvocationAcademySession getConvocationAcademySession()
                                                throws OperationFailedException

Gets the session for retrieving convocation to academy mappings.

Returns:

a ConvocationAcademySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationAcademy() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationAcademy()} is {@code true} .

getConvocationAcademyAssignmentSession

ConvocationAcademyAssignmentSession getConvocationAcademyAssignmentSession()
                                                                    throws OperationFailedException

Gets the session for assigning convocation to academy mappings.

Returns:

a ConvocationAcademyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationAcademyAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationAcademyAssignment()} is {@code true} .

getConvocationSmartAcademySession

ConvocationSmartAcademySession getConvocationSmartAcademySession(Id academyId)
                                                          throws NotFoundException,
OperationFailedException

Gets the session associated with the convocation smart academy for the given academy.

Parameters:

academyId - the Id of the convocation book

Returns:

a ConvocationSmartAcademySession

Throws:

NotFoundException - convocationBookId not found

NullArgumentException - convocationBookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationSmartAcademy() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationSmartAcademy()} is {@code true} .

getAcademyLookupSession

AcademyLookupSession getAcademyLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the academy lookup service.

Returns:

an AcademyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyLookup()} is {@code true} .

getAcademyQuerySession

AcademyQuerySession getAcademyQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the academy query service.

Returns:

an AcademyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyQuery()} is {@code true} .

getAcademySearchSession

AcademySearchSession getAcademySearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the academy search service.

Returns:

an AcademySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademySearch()} is {@code true} .

getAcademyAdminSession

AcademyAdminSession getAcademyAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the academy administrative service.

Returns:

an AcademyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyAdmin()} is {@code true} .

getAcademyNotificationSession

AcademyNotificationSession getAcademyNotificationSession(AcademyReceiver academyReceiver)
                                                  throws OperationFailedException

Gets the OsidSession associated with the academy notification service.

Parameters:

academyReceiver - the receiver

Returns:

an AcademyNotificationSession

Throws:

NullArgumentException - academyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyNotification()} is {@code true} .

getAcademyHierarchySession

AcademyHierarchySession getAcademyHierarchySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the academy hierarchy service.

Returns:

an AcademyHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyHierarchy()} is {@code true} .

getAcademyHierarchyDesignSession

AcademyHierarchyDesignSession getAcademyHierarchyDesignSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with the academy hierarchy design service.

Returns:

an AcademyHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyHierarchyDesign()} is {@code true} .

getRecognitionBatchManager

RecognitionBatchManager getRecognitionBatchManager()
                                            throws OperationFailedException

Gets a RecognitionBatchManager .

Returns:

a RecognitionBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecognitionBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsRecognitionBatch()} is {@code true} .