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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ConferralLookupSession getConferralLookupSession() throws OperationFailedException
OsidSession
associated with the conferral
lookup service. ConferralLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralLookup()
is false
optional
- This method must be implemented if
supportsConferralLookup()
is true.
ConferralLookupSession getConferralLookupSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
lookup service for the given academy.academyId
- the Id
of the Academy
ConferralLookupSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConferralLookup()
and
supportsVisibleFederation()
are true
ConferralQuerySession getConferralQuerySession() throws OperationFailedException
OsidSession
associated with the conferral
query service. ConferralQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralQuery()
is false
optional
- This method must be implemented if
supportsConferralQuery()
is true.
ConferralQuerySession getConferralQuerySessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
query service for the given academy.academyId
- the Id
of the Academy
ConferralQuerySession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConferralQuery()
and
supportsVisibleFederation()
are true
ConferralSearchSession getConferralSearchSession() throws OperationFailedException
OsidSession
associated with the conferral
search service. ConferralSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralSearch()
is false
optional
- This method must be implemented if
supportsConferralSearch()
is true.
ConferralSearchSession getConferralSearchSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
search service for the given academy.academyId
- the Id
of the Academy
ConferralSearchSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConferralSearch()
and
supportsVisibleFederation()
are true
ConferralAdminSession getConferralAdminSession() throws OperationFailedException
OsidSession
associated with the conferral
administration service. ConferralAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAdmin()
is false
optional
- This method must be implemented if
supportsConferralAdmin()
is true.
ConferralAdminSession getConferralAdminSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
administration service for the given academy.academyId
- the Id
of the Academy
ConferralAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConferralAdmin()
and
supportsVisibleFederation()
are true
ConferralNotificationSession getConferralNotificationSession(ConferralReceiver conferralReceiver) throws OperationFailedException
OsidSession
associated with the conferral
notification service.conferralReceiver
- the receiver ConferralNotificationSession
NullArgumentException
- conferralReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralNotification()
is false
optional
- This method must be implemented if
supportsConferralNotification()
is true.
ConferralNotificationSession getConferralNotificationSessionForAcademy(ConferralReceiver conferralReceiver, Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
notification service for the given academy.conferralReceiver
- the receiveracademyId
- the Id
of the Academy
ConferralNotificationSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- conferralReceiver
or academyId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConferralNotification()
and
supportsVisibleFederation()
are true
ConferralAcademySession getConferralAcademySession() throws OperationFailedException
ConferralAcademySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAcademy()
is false
optional
- This method must be implemented if
supportsConferralAcademy()
is true.
ConferralAcademyAssignmentSession getConferralAcademyAssignmentSession() throws OperationFailedException
ConferralAcademyAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAcademyAssignment()
is false
optional
- This method must be implemented if
supportsConferralAcademyAssignment()
is
true.
ConferralSmartAcademySession getConferralSmartAcademySession(Id academyId) throws NotFoundException, OperationFailedException
academyId
- the Id
of the academy ConferralSmartAcademySession
NotFoundException
- conferralBookId
not
foundNullArgumentException
- conferralBookId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralSmartAcademy()
is false
optional
- This method must be implemented if
supportsConferralSmartAcademy()
is true.
AwardLookupSession getAwardLookupSession() throws OperationFailedException
OsidSession
associated with the award lookup
service. AwardLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardLookup()
is false
optional
- This method must be implemented if
supportsAwardLookup()
is true.
AwardLookupSession getAwardLookupSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the award lookup
service for the given academy.academyId
- the Id
of the Academy
AwardLookupSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAwardLookup()
and
supportsVisibleFederation()
are true
AwardQuerySession getAwardQuerySession() throws OperationFailedException
OsidSession
associated with the award query
service. AwardQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardQuery()
is false
optional
- This method must be implemented if
supportsAwardQuery()
is true.
AwardQuerySession getAwardQuerySessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the award query
service for the given academy.academyId
- the Id
of the Academy
AwardQuerySession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAwardQuery()
and
supportsVisibleFederation()
are true
AwardSearchSession getAwardSearchSession() throws OperationFailedException
OsidSession
associated with the award search
service. AwardSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardSearch()
is false
optional
- This method must be implemented if
supportsAwardSearch()
is true.
AwardSearchSession getAwardSearchSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the award search
service for the given academy.academyId
- the Id
of the Academy
AwardSearchSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAwardSearch()
and
supportsVisibleFederation()
are true
AwardAdminSession getAwardAdminSession() throws OperationFailedException
OsidSession
associated with the award
administrative service. AwardAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardAdmin()
is false
optional
- This method must be implemented if
supportsAwardAdmin()
is true.
AwardAdminSession getAwardAdminSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the award
administrative service for the given academy.academyId
- the Id
of the Academy
AwardAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAwardAdmin()
and
supportsVisibleFederation()
are true
AwardNotificationSession getAwardNotificationSession(AwardReceiver awardReceiver) throws OperationFailedException
OsidSession
associated with the award
notification service.awardReceiver
- the receiver AwardNotificationSession
NullArgumentException
- awardReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardNotification()
is false
optional
- This method must be implemented if
supportsAwardNotification()
is true.
AwardNotificationSession getAwardNotificationSessionForAcademy(AwardReceiver awardReceiver, Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the award
notification service for the given academy.awardReceiver
- the receiveracademyId
- the Id
of the Academy
AwardNotificationSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- awardReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAwardNotification()
and
supportsVisibleFederation()
are true
AwardAcademySession getAwardAcademySession() throws OperationFailedException
AwardAcademySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardAcademy()
is false
optional
- This method must be implemented if
supportsAwardAcademy()
is true.
AwardAcademyAssignmentSession getAwardAcademyAssignmentSession() throws OperationFailedException
AwardAcademyAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardAcademyAssignment()
is false
optional
- This method must be implemented if
supportsAwardAcademyAssignment()
is true.
AwardSmartAcademySession getAwardSmartAcademySession(Id academyId) throws NotFoundException, OperationFailedException
academyId
- the Id
of the academy AwardSmartAcademySession
NotFoundException
- academyId
not foundNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardSmartAcademy()
is false
optional
- This method must be implemented if
supportsAwardSmartAcademy()
is true.
ConvocationLookupSession getConvocationLookupSession() throws OperationFailedException
OsidSession
associated with the convocation
lookup service. ConvocationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationLookup()
is false
optional
- This method must be implemented if
supportsConvocationLookup()
is true.
ConvocationLookupSession getConvocationLookupSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
lookup service for the given academy.academyId
- the Id
of the Academy
ConvocationLookupSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConvocationLookup()
and
supportsVisibleFederation()
are true
ConvocationQuerySession getConvocationQuerySession() throws OperationFailedException
OsidSession
associated with the convocation
query service. ConvocationQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationQuery()
is false
optional
- This method must be implemented if
supportsConvocationQuery()
is true.
ConvocationQuerySession getConvocationQuerySessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
query service for the given academy.academyId
- the Id
of the Academy
ConvocationQuerySession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConvocationQuery()
and
supportsVisibleFederation()
are true
ConvocationSearchSession getConvocationSearchSession() throws OperationFailedException
OsidSession
associated with the convocation
search service. ConvocationSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationSearch()
is false
optional
- This method must be implemented if
supportsConvocationSearch()
is true.
ConvocationSearchSession getConvocationSearchSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
search service for the given academy.academyId
- the Id
of the Academy
ConvocationSearchSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConvocationSearch()
and
supportsVisibleFederation()
are true
ConvocationAdminSession getConvocationAdminSession() throws OperationFailedException
OsidSession
associated with the convocation
administration service. ConvocationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAdmin()
is false
optional
- This method must be implemented if
supportsConvocationAdmin()
is true.
ConvocationAdminSession getConvocationAdminSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
administration service for the given academy.academyId
- the Id
of the Academy
ConvocationAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConvocationAdmin()
and
supportsVisibleFederation()
are true
ConvocationNotificationSession getConvocationNotificationSession(ConvocationReceiver convocationReceiver) throws OperationFailedException
OsidSession
associated with the convocation
notification service.convocationReceiver
- the receiver ConvocationNotificationSession
NullArgumentException
- convocationReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationNotification()
is false
optional
- This method must be implemented if
supportsConvocationNotification()
is true.
ConvocationNotificationSession getConvocationNotificationSessionForAcademy(ConvocationReceiver convocationReceiver, Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
notification service for the given academy.convocationReceiver
- the receiveracademyId
- the Id
of the Academy
ConvocationNotificationSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- convocationReceiver
or academyId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConvocationNotification()
and
supportsVisibleFederation()
are true
ConvocationAcademySession getConvocationAcademySession() throws OperationFailedException
ConvocationAcademySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAcademy()
is false
optional
- This method must be implemented if
supportsConvocationAcademy()
is true.
ConvocationAcademyAssignmentSession getConvocationAcademyAssignmentSession() throws OperationFailedException
ConvocationAcademyAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAcademyAssignment()
is false
optional
- This method must be implemented if
supportsConvocationAcademyAssignment()
is
true.
ConvocationSmartAcademySession getConvocationSmartAcademySession(Id academyId) throws NotFoundException, OperationFailedException
academyId
- the Id
of the convocation book ConvocationSmartAcademySession
NotFoundException
- convocationBookId
not foundNullArgumentException
- convocationBookId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationSmartAcademy()
is false
optional
- This method must be implemented if
supportsConvocationSmartAcademy()
is true.
AcademyLookupSession getAcademyLookupSession() throws OperationFailedException
OsidSession
associated with the academy lookup
service. AcademyLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademyLookup()
is false
optional
- This method must be implemented if
supportsAcademyLookup()
is true.
AcademyQuerySession getAcademyQuerySession() throws OperationFailedException
OsidSession
associated with the academy query
service. AcademyQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademyQuery()
is false
optional
- This method must be implemented if
supportsAcademyQuery()
is true.
AcademySearchSession getAcademySearchSession() throws OperationFailedException
OsidSession
associated with the academy search
service. AcademySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademySearch()
is false
optional
- This method must be implemented if
supportsAcademySearch()
is true.
AcademyAdminSession getAcademyAdminSession() throws OperationFailedException
OsidSession
associated with the academy
administrative service. AcademyAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademyAdmin()
is false
optional
- This method must be implemented if
supportsAcademyAdmin()
is true.
AcademyNotificationSession getAcademyNotificationSession(AcademyReceiver academyReceiver) throws OperationFailedException
OsidSession
associated with the academy
notification service.academyReceiver
- the receiver AcademyNotificationSession
NullArgumentException
- academyReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyNotification()
is false
optional
- This method must be implemented if
supportsAcademyNotification()
is true.
AcademyHierarchySession getAcademyHierarchySession() throws OperationFailedException
OsidSession
associated with the academy
hierarchy service. AcademyHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyHierarchy()
is false
optional
- This method must be implemented if
supportsAcademyHierarchy()
is true.
AcademyHierarchyDesignSession getAcademyHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the academy
hierarchy design service. AcademyHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyHierarchyDesign()
is false
optional
- This method must be implemented if
supportsAcademyHierarchyDesign()
is true.
RecognitionBatchManager getRecognitionBatchManager() throws OperationFailedException
RecognitionBatchManager.
RecognitionBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecognitionBatch()
is false
optional
- This method must be implemented if
supportsRecognitionBatch()
is true.