org.osid.recognition

Interface RecognitionProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, RecognitionProfile, Sourceable

public interface RecognitionProxyManager
extends OsidProxyManager, RecognitionProfile

The recognition manager provides access to conferral sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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(Proxy proxy) Gets the OsidSession associated with the academy administrative service.
AcademyHierarchyDesignSession	getAcademyHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the academy hierarchy design service.
AcademyHierarchySession	getAcademyHierarchySession(Proxy proxy) Gets the OsidSession associated with the academy hierarchy service.
AcademyLookupSession	getAcademyLookupSession(Proxy proxy) Gets the OsidSession associated with the academy lookup service.
AcademyNotificationSession	getAcademyNotificationSession(AcademyReceiver academyReceiver, Proxy proxy) Gets the OsidSession associated with the academy notification service.
AcademyQuerySession	getAcademyQuerySession(Proxy proxy) Gets the OsidSession associated with the academy query service.
AcademySearchSession	getAcademySearchSession(Proxy proxy) Gets the OsidSession associated with the academy search service.
AwardAcademyAssignmentSession	getAwardAcademyAssignmentSession(Proxy proxy) Gets the session for assigning award to academy mappings.
AwardAcademySession	getAwardAcademySession(Proxy proxy) Gets the session for retrieving award to academy mappings.
AwardAdminSession	getAwardAdminSession(Proxy proxy) Gets the OsidSession associated with the award administrative service.
AwardAdminSession	getAwardAdminSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the award administration service for the given academy.
AwardLookupSession	getAwardLookupSession(Proxy proxy) Gets the OsidSession associated with the award lookup service.
AwardLookupSession	getAwardLookupSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the award lookup service for the given academy.
AwardNotificationSession	getAwardNotificationSession(AwardReceiver awardReceiver, Proxy proxy) Gets the OsidSession associated with the award notification service.
AwardNotificationSession	getAwardNotificationSessionForAcademy(AwardReceiver awardReceiver, Id academyId, Proxy proxy) Gets the OsidSession associated with the award notification service for the given academy.
AwardQuerySession	getAwardQuerySession(Proxy proxy) Gets the OsidSession associated with the award query service.
AwardQuerySession	getAwardQuerySessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the award query service for the given academy.
AwardSearchSession	getAwardSearchSession(Proxy proxy) Gets the OsidSession associated with the award search service.
AwardSearchSession	getAwardSearchSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the award search service for the given academy.
AwardSmartAcademySession	getAwardSmartAcademySession(Id academyId, Proxy proxy) Gets the session for managing dynamic award academies for the given academy.
ConferralAcademyAssignmentSession	getConferralAcademyAssignmentSession(Proxy proxy) Gets the session for assigning conferral to academy mappings.
ConferralAcademySession	getConferralAcademySession(Proxy proxy) Gets the session for retrieving conferral to academy mappings.
ConferralAdminSession	getConferralAdminSession(Proxy proxy) Gets the OsidSession associated with the conferral administration service.
ConferralAdminSession	getConferralAdminSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the conferral administration service for the given academy.
ConferralLookupSession	getConferralLookupSession(Proxy proxy) Gets the OsidSession associated with the conferral lookup service.
ConferralLookupSession	getConferralLookupSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the conferral lookup service for the given academy.
ConferralNotificationSession	getConferralNotificationSession(ConferralReceiver conferralReceiver, Proxy proxy) Gets the OsidSession associated with the conferral notification service.
ConferralNotificationSession	getConferralNotificationSessionForAcademy(ConferralReceiver conferralReceiver, Id academyId, Proxy proxy) Gets the OsidSession associated with the conferral notification service for the given academy.
ConferralQuerySession	getConferralQuerySession(Proxy proxy) Gets the OsidSession associated with the conferral query service.
ConferralQuerySession	getConferralQuerySessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the conferral query service for the given academy.
ConferralSearchSession	getConferralSearchSession(Proxy proxy) Gets the OsidSession associated with the conferral search service.
ConferralSearchSession	getConferralSearchSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the conferral search service for the given academy.
ConferralSmartAcademySession	getConferralSmartAcademySession(Id academyId, Proxy proxy) Gets the session associated with the conferral smart academy for the given academy.
ConvocationAcademyAssignmentSession	getConvocationAcademyAssignmentSession(Proxy proxy) Gets the session for assigning convocation to academy mappings.
ConvocationAcademySession	getConvocationAcademySession(Proxy proxy) Gets the session for retrieving convocation to academy mappings.
ConvocationAdminSession	getConvocationAdminSession(Proxy proxy) Gets the OsidSession associated with the convocation administration service.
ConvocationAdminSession	getConvocationAdminSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the convocation administration service for the given academy.
ConvocationLookupSession	getConvocationLookupSession(Proxy proxy) Gets the OsidSession associated with the convocation lookup service.
ConvocationLookupSession	getConvocationLookupSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the convocation lookup service for the given academy.
ConvocationNotificationSession	getConvocationNotificationSession(ConvocationReceiver convocationReceiver, Proxy proxy) Gets the OsidSession associated with the convocation notification service.
ConvocationNotificationSession	getConvocationNotificationSessionForAcademy(ConvocationReceiver convocationReceiver, Id academyId, Proxy proxy) Gets the OsidSession associated with the convocation notification service for the given academy.
ConvocationQuerySession	getConvocationQuerySession(Proxy proxy) Gets the OsidSession associated with the convocation query service.
ConvocationQuerySession	getConvocationQuerySessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the convocation query service for the given academy.
ConvocationSearchSession	getConvocationSearchSession(Proxy proxy) Gets the OsidSession associated with the convocation search service.
ConvocationSearchSession	getConvocationSearchSessionForAcademy(Id academyId, Proxy proxy) Gets the OsidSession associated with the convocation search service for the given academy.
ConvocationSmartAcademySession	getConvocationSmartAcademySession(Id academyId, Proxy proxy) Gets the session associated with the convocation smart academy for the given academy.
RecognitionBatchProxyManager	getRecognitionBatchProxyManager() Gets a RecognitionBatchProxyManager.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the conferral lookup service.

Parameters:

proxy - a proxy

Returns:

a ConferralLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConferralLookupSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the conferral query service.

Parameters:

proxy - a proxy

Returns:

a ConferralQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConferralQuerySession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the conferral search service.

Parameters:

proxy - a proxy

Returns:

a ConferralSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConferralSearchSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the conferral administration service.

Parameters:

proxy - a proxy

Returns:

a ConferralAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConferralAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the conferral notification service.

Parameters:

conferralReceiver - the receiver

proxy - a proxy

Returns:

a ConferralNotificationSession

Throws:

NullArgumentException - conferralReceiver or proxy 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,
                                                                     Proxy proxy)
                                                                       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

proxy - a proxy

Returns:

a ConferralNotificationSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - conferralReceiver, academyId, or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the session for retrieving conferral to academy mappings.

Parameters:

proxy - a proxy

Returns:

a ConferralAcademySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralAcademy() is false

Compliance:

optional - This method must be implemented if supportsConferralAcademy() is true.

getConferralAcademyAssignmentSession

ConferralAcademyAssignmentSession getConferralAcademyAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the session for assigning conferral to academy mappings.

Parameters:

proxy - a proxy

Returns:

a ConferralAcademyAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

academyId - the Id of the conferral book

proxy - a proxy

Returns:

a ConferralSmartAcademySession

Throws:

NotFoundException - conferralBookId not found

NullArgumentException - conferralBookId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the award lookup service.

Parameters:

proxy - a proxy

Returns:

an AwardLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

an AwardLookupSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the award query service.

Parameters:

proxy - a proxy

Returns:

an AwardQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

an AwardQuerySession

Throws:

NotFoundException - no Award found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the award search service.

Parameters:

proxy - a proxy

Returns:

an AwardSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

an AwardSearchSession

Throws:

NotFoundException - no Award found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the award administrative service.

Parameters:

proxy - a proxy

Returns:

an AwardAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

an AwardAdminSession

Throws:

NotFoundException - no Award found by the given Id

NullArgumentException - academyId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the award notification service.

Parameters:

awardReceiver - the receiver

proxy - a proxy

Returns:

an AwardNotificationSession

Throws:

NullArgumentException - awardReceiver or proxy 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,
                                                             Proxy proxy)
                                                               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

proxy - a proxy

Returns:

an AwardNotificationSession

Throws:

NotFoundException - no Award found by the given Id

NullArgumentException - awardReceiver, academyId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the session for retrieving award to academy mappings.

Parameters:

proxy - a proxy

Returns:

an AwardAcademySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardAcademy() is false

Compliance:

optional - This method must be implemented if supportsAwardAcademy() is true.

getAwardAcademyAssignmentSession

AwardAcademyAssignmentSession getAwardAcademyAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session for assigning award to academy mappings.

Parameters:

proxy - a proxy

Returns:

an AwardAcademyAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the session for managing dynamic award academies for the given academy.

Parameters:

academyId - the Id of an academy

proxy - a proxy

Returns:

an AwardSmartAcademySession

Throws:

NotFoundException - academyId is not found

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the convocation lookup service.

Parameters:

proxy - a proxy

Returns:

a ConvocationLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConvocationLookupSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the convocation query service.

Parameters:

proxy - a proxy

Returns:

a ConvocationQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConvocationQuerySession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the convocation search service.

Parameters:

proxy - a proxy

Returns:

a ConvocationSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConvocationSearchSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the convocation administration service.

Parameters:

proxy - a proxy

Returns:

a ConvocationAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConvocationAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the convocation notification service.

Parameters:

convocationReceiver - the receiver

proxy - a proxy

Returns:

a ConvocationNotificationSession

Throws:

NullArgumentException - convocationReceiver or proxy 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,
                                                                         Proxy proxy)
                                                                           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

proxy - a proxy

Returns:

a ConvocationNotificationSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - convocationReceiver, academyId, or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the session for retrieving convocation to academy mappings.

Parameters:

proxy - a proxy

Returns:

a ConvocationAcademySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationAcademy() is false

Compliance:

optional - This method must be implemented if supportsConvocationAcademy() is true.

getConvocationAcademyAssignmentSession

ConvocationAcademyAssignmentSession getConvocationAcademyAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the session for assigning convocation to academy mappings.

Parameters:

proxy - a proxy

Returns:

a ConvocationAcademyAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

academyId - the Id of the convocation book

proxy - a proxy

Returns:

a ConvocationSmartAcademySession

Throws:

NotFoundException - convocationBookId not found

NullArgumentException - convocationBookId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the academy lookup service.

Parameters:

proxy - a proxy

Returns:

an AcademyLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyLookup() is false

Compliance:

optional - This method must be implemented if supportsAcademyLookup() is true.

getAcademyQuerySession

AcademyQuerySession getAcademyQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the academy query service.

Parameters:

proxy - a proxy

Returns:

an AcademyQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyQuery() is false

Compliance:

optional - This method must be implemented if supportsAcademyQuery() is true.

getAcademySearchSession

AcademySearchSession getAcademySearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the academy search service.

Parameters:

proxy - a proxy

Returns:

an AcademySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademySearch() is false

Compliance:

optional - This method must be implemented if supportsAcademySearch() is true.

getAcademyAdminSession

AcademyAdminSession getAcademyAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the academy administrative service.

Parameters:

proxy - a proxy

Returns:

an AcademyAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the academy notification service.

Parameters:

academyReceiver - the receiver

proxy - a proxy

Returns:

an AcademyNotificationSession

Throws:

NullArgumentException - academyReceiver or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the academy hierarchy service.

Parameters:

proxy - a proxy

Returns:

an AcademyHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyHierarchy() is false

Compliance:

optional - This method must be implemented if supportsAcademyHierarchy() is true.

getAcademyHierarchyDesignSession

AcademyHierarchyDesignSession getAcademyHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the academy hierarchy design service.

Parameters:

proxy - a proxy

Returns:

an AcademyHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsAcademyHierarchyDesign() is true.

getRecognitionBatchProxyManager

RecognitionBatchProxyManager getRecognitionBatchProxyManager()
                                                             throws OperationFailedException

Gets a RecognitionBatchProxyManager.

Returns:

a RecognitionBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecognitionBatch() is false

Compliance:

optional - This method must be implemented if supportsRecognitionBatch() is true.