org.osid.recognition

Interface RecognitionManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.recognition.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsConferralLookup() is 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 supportsConferralLookup() and supportsVisibleFederation() are 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 supportsConferralQuery() is 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 supportsConferralQuery() and supportsVisibleFederation() are 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 supportsConferralSearch() is 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 supportsConferralSearch() and supportsVisibleFederation() are 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 supportsConferralAdmin() is 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 supportsConferralAdmin() and supportsVisibleFederation() are 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 supportsConferralNotification() is 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 supportsConferralNotification() and supportsVisibleFederation() are 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 supportsConferralAcademy() is 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 supportsConferralAcademyAssignment() is 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 supportsConferralSmartAcademy() is 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 supportsAwardLookup() is 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 supportsAwardLookup() and supportsVisibleFederation() are 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 supportsAwardQuery() is 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 supportsAwardQuery() and supportsVisibleFederation() are 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 supportsAwardSearch() is 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 supportsAwardSearch() and supportsVisibleFederation() are 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 supportsAwardAdmin() is 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 supportsAwardAdmin() and supportsVisibleFederation() are 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 supportsAwardNotification() is 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 supportsAwardNotification() and supportsVisibleFederation() are 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 supportsAwardAcademy() is 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 supportsAwardAcademyAssignment() is 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 supportsAwardSmartAcademy() is 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 supportsConvocationLookup() is 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 supportsConvocationLookup() and supportsVisibleFederation() are 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 supportsConvocationQuery() is 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 supportsConvocationQuery() and supportsVisibleFederation() are 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 supportsConvocationSearch() is 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 supportsConvocationSearch() and supportsVisibleFederation() are 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 supportsConvocationAdmin() is 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 supportsConvocationAdmin() and supportsVisibleFederation() are 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 supportsConvocationNotification() is 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 supportsConvocationNotification() and supportsVisibleFederation() are 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 supportsConvocationAcademy() is 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 supportsConvocationAcademyAssignment() is 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 supportsConvocationSmartAcademy() is 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 supportsAcademyLookup() is 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 supportsAcademyQuery() is 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 supportsAcademySearch() is 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 supportsAcademyAdmin() is 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 supportsAcademyNotification() is 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 supportsAcademyHierarchy() is 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 supportsAcademyHierarchyDesign() is 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 supportsRecognitionBatch() is true.