public interface RecognitionBatchManager extends OsidManager, RecognitionBatchProfile
The recognition batch manager provides access to recognition batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
ConferralBatchAdminSession:
a session to create,
modify and delete Conferrals
in bulk AwardBatchAdminSession:
a session to create,
modify and delete Awards in bulk ConvocationBatchAdminSession:
a session to create,
modify and delete Convocations in bulk AcademyBatchAdminSession:
a session to create,
modify and delete Academy
in bulk Modifier and Type | Method and Description |
---|---|
AcademyBatchAdminSession |
getAcademyBatchAdminSession()
Gets the
OsidSession associated with the bulk academy
administration service. |
AwardBatchAdminSession |
getAwardBatchAdminSession()
Gets the
OsidSession associated with the bulk award
administration service. |
AwardBatchAdminSession |
getAwardBatchAdminSessionForAcademy(Id academyId)
Gets the
OsidSession associated with the bulk award
administration service for the given academy. |
ConferralBatchAdminSession |
getConferralBatchAdminSession()
Gets the
OsidSession associated with the bulk conferral
administration service. |
ConferralBatchAdminSession |
getConferralBatchAdminSessionForAcademy(Id academyId)
Gets the
OsidSession associated with the bulk conferral
administration service for the given academy. |
ConvocationBatchAdminSession |
getConvocationBatchAdminSession()
Gets the
OsidSession associated with the bulk
convocation administration service. |
ConvocationBatchAdminSession |
getConvocationBatchAdminSessionForAcademy(Id academyId)
Gets the
OsidSession associated with the bulk
convocation administration service for the given academy. |
changeBranch, initialize, rollbackService
close
supportsAcademyBatchAdmin, supportsAwardBatchAdmin, supportsConferralBatchAdmin, supportsConvocationBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ConferralBatchAdminSession getConferralBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk conferral
administration service. ConferralBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralBatchAdmin()
is false
optional
- This method must be implemented if
supportsConferralBatchAdmin()
is true.
ConferralBatchAdminSession getConferralBatchAdminSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk conferral
administration service for the given academy.academyId
- the Id
of the Academy
ConferralBatchAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConferralBatchAdmin()
and
supportsVisibleFederation()
are true
AwardBatchAdminSession getAwardBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk award
administration service. AwardBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardBatchAdmin()
is false
optional
- This method must be implemented if
supportsAwardBatchAdmin()
is true.
AwardBatchAdminSession getAwardBatchAdminSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk award
administration service for the given academy.academyId
- the Id
of the Academy
AwardBatchAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAwardBatchAdmin()
and
supportsVisibleFederation()
are true
ConvocationBatchAdminSession getConvocationBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
convocation administration service. ConvocationBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationBatchAdmin()
is false
optional
- This method must be implemented if
supportsConvocationBatchAdmin()
is true.
ConvocationBatchAdminSession getConvocationBatchAdminSessionForAcademy(Id academyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
convocation administration service for the given academy.academyId
- the Id
of the Academy
ConvocationBatchAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsConvocationBatchAdmin()
and
supportsVisibleFederation()
are true
AcademyBatchAdminSession getAcademyBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk academy
administration service. AcademyBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyBatchAdmin()
is false
optional
- This method must be implemented if
supportsAcademyBatchAdmin()
is true.