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.
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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the conferral
lookup service.proxy
- a proxy ConferralLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralLookup()
is false
optional
- This method must be implemented if
supportsConferralLookup()
is true.
ConferralLookupSession getConferralLookupSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
lookup service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConferralLookupSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the conferral
query service.proxy
- a proxy ConferralQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralQuery()
is false
optional
- This method must be implemented if
supportsConferralQuery()
is true.
ConferralQuerySession getConferralQuerySessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
query service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConferralQuerySession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the conferral
search service.proxy
- a proxy ConferralSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralSearch()
is false
optional
- This method must be implemented if
supportsConferralSearch()
is true.
ConferralSearchSession getConferralSearchSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
search service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConferralSearchSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the conferral
administration service.proxy
- a proxy ConferralAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAdmin()
is false
optional
- This method must be implemented if
supportsConferralAdmin()
is true.
ConferralAdminSession getConferralAdminSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
administration service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConferralAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the conferral
notification service.conferralReceiver
- the receiverproxy
- a proxy ConferralNotificationSession
NullArgumentException
- conferralReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the conferral
notification service for the given academy.conferralReceiver
- the receiveracademyId
- the Id
of the Academy
proxy
- a proxy ConferralNotificationSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- conferralReceiver,
academyId,
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConferralAcademySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAcademy()
is false
optional
- This method must be implemented if
supportsConferralAcademy()
is true.
ConferralAcademyAssignmentSession getConferralAcademyAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConferralAcademyAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralAcademyAssignment()
is false
optional
- This method must be implemented if
supportsConferralAcademyAssignment()
is
true.
ConferralSmartAcademySession getConferralSmartAcademySession(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
academyId
- the Id
of the conferral bookproxy
- a proxy ConferralSmartAcademySession
NotFoundException
- conferralBookId
not
foundNullArgumentException
- conferralBookId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralSmartAcademy()
is false
optional
- This method must be implemented if
supportsConferralSmartAcademy()
is true.
AwardLookupSession getAwardLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the award lookup
service.proxy
- a proxy AwardLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardLookup()
is false
optional
- This method must be implemented if
supportsAwardLookup()
is true.
AwardLookupSession getAwardLookupSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the award lookup
service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy AwardLookupSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the award query
service.proxy
- a proxy AwardQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardQuery()
is false
optional
- This method must be implemented if
supportsAwardQuery()
is true.
AwardQuerySession getAwardQuerySessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the award query
service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy AwardQuerySession
NotFoundException
- no Award
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the award search
service.proxy
- a proxy AwardSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardSearch()
is false
optional
- This method must be implemented if
supportsAwardSearch()
is true.
AwardSearchSession getAwardSearchSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the award search
service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy AwardSearchSession
NotFoundException
- no Award
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the award
administrative service.proxy
- a proxy AwardAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardAdmin()
is false
optional
- This method must be implemented if
supportsAwardAdmin()
is true.
AwardAdminSession getAwardAdminSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the award
administration service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy AwardAdminSession
NotFoundException
- no Award
found by
the given Id
NullArgumentException
- academyId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the award
notification service.awardReceiver
- the receiverproxy
- a proxy AwardNotificationSession
NullArgumentException
- awardReceiver
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the award
notification service for the given academy.awardReceiver
- the receiveracademyId
- the Id
of the Academy
proxy
- a proxy AwardNotificationSession
NotFoundException
- no Award
found by
the given Id
NullArgumentException
- awardReceiver, academyId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy AwardAcademySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAwardAcademy()
is false
optional
- This method must be implemented if
supportsAwardAcademy()
is true.
AwardAcademyAssignmentSession getAwardAcademyAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AwardAcademyAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardAcademyAssignment()
is false
optional
- This method must be implemented if
supportsAwardAcademyAssignment()
is true.
AwardSmartAcademySession getAwardSmartAcademySession(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
academyId
- the Id
of an academyproxy
- a proxy AwardSmartAcademySession
NotFoundException
- academyId
is not
foundNullArgumentException
- academyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardSmartAcademy()
is false
optional
- This method must be implemented if
supportsAwardSmartAcademy()
is true.
ConvocationLookupSession getConvocationLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the convocation
lookup service.proxy
- a proxy ConvocationLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationLookup()
is false
optional
- This method must be implemented if
supportsConvocationLookup()
is true.
ConvocationLookupSession getConvocationLookupSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
lookup service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConvocationLookupSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the convocation
query service.proxy
- a proxy ConvocationQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationQuery()
is false
optional
- This method must be implemented if
supportsConvocationQuery()
is true.
ConvocationQuerySession getConvocationQuerySessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
query service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConvocationQuerySession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the convocation
search service.proxy
- a proxy ConvocationSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationSearch()
is false
optional
- This method must be implemented if
supportsConvocationSearch()
is true.
ConvocationSearchSession getConvocationSearchSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
search service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConvocationSearchSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the convocation
administration service.proxy
- a proxy ConvocationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAdmin()
is false
optional
- This method must be implemented if
supportsConvocationAdmin()
is true.
ConvocationAdminSession getConvocationAdminSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
administration service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConvocationAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the convocation
notification service.convocationReceiver
- the receiverproxy
- a proxy ConvocationNotificationSession
NullArgumentException
- convocationReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the convocation
notification service for the given academy.convocationReceiver
- the receiveracademyId
- the Id
of the Academy
proxy
- a proxy ConvocationNotificationSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- convocationReceiver,
academyId,
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConvocationAcademySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAcademy()
is false
optional
- This method must be implemented if
supportsConvocationAcademy()
is true.
ConvocationAcademyAssignmentSession getConvocationAcademyAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConvocationAcademyAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationAcademyAssignment()
is false
optional
- This method must be implemented if
supportsConvocationAcademyAssignment()
is
true.
ConvocationSmartAcademySession getConvocationSmartAcademySession(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
academyId
- the Id
of the convocation bookproxy
- a proxy ConvocationSmartAcademySession
NotFoundException
- convocationBookId
not foundNullArgumentException
- convocationBookId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationSmartAcademy()
is false
optional
- This method must be implemented if
supportsConvocationSmartAcademy()
is true.
AcademyLookupSession getAcademyLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy lookup
service.proxy
- a proxy AcademyLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademyLookup()
is false
optional
- This method must be implemented if
supportsAcademyLookup()
is true.
AcademyQuerySession getAcademyQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy query
service.proxy
- a proxy AcademyQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademyQuery()
is false
optional
- This method must be implemented if
supportsAcademyQuery()
is true.
AcademySearchSession getAcademySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy search
service.proxy
- a proxy AcademySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademySearch()
is false
optional
- This method must be implemented if
supportsAcademySearch()
is true.
AcademyAdminSession getAcademyAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy
administrative service.proxy
- a proxy AcademyAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAcademyAdmin()
is false
optional
- This method must be implemented if
supportsAcademyAdmin()
is true.
AcademyNotificationSession getAcademyNotificationSession(AcademyReceiver academyReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy
notification service.academyReceiver
- the receiverproxy
- a proxy AcademyNotificationSession
NullArgumentException
- academyReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyNotification()
is false
optional
- This method must be implemented if
supportsAcademyNotification()
is true.
AcademyHierarchySession getAcademyHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy
hierarchy service.proxy
- a proxy AcademyHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyHierarchy()
is false
optional
- This method must be implemented if
supportsAcademyHierarchy()
is true.
AcademyHierarchyDesignSession getAcademyHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the academy
hierarchy design service.proxy
- a proxy AcademyHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyHierarchyDesign()
is false
optional
- This method must be implemented if
supportsAcademyHierarchyDesign()
is true.
RecognitionBatchProxyManager getRecognitionBatchProxyManager() throws OperationFailedException
RecognitionBatchProxyManager.
RecognitionBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecognitionBatch()
is false
optional
- This method must be implemented if
supportsRecognitionBatch()
is true.