public interface RecognitionBatchProxyManager extends OsidProxyManager, RecognitionBatchProfile
The recognition batch proxy manager provides access to recognition
batch sessions and provides interoperability tests for various aspects of
this service. Methods in this manager support the passing of a
Proxy
object. The sessions included in this manager are:
ConferralBatchAdminSession:
a session to manage
conferrals in bulk AwardBatchAdminSession:
a session to manage awardd
in bulk ConvocationBatchAdminSession:
a session to manage
convocations in bulk AcademyBatchAdminSession:
a session to create,
modify and delete Academy
in bulk Modifier and Type | Method and Description |
---|---|
AcademyBatchAdminSession |
getAcademyBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk academy
administration service. |
AwardBatchAdminSession |
getAwardBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk award
administration service. |
AwardBatchAdminSession |
getAwardBatchAdminSessionForAcademy(Id academyId,
Proxy proxy)
Gets the
OsidSession associated with the bulk award
administration service for the given academy. |
ConferralBatchAdminSession |
getConferralBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk conferral
administration service. |
ConferralBatchAdminSession |
getConferralBatchAdminSessionForAcademy(Id academyId,
Proxy proxy)
Gets the
OsidSession associated with the bulk conferral
administration service for the given academy. |
ConvocationBatchAdminSession |
getConvocationBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk
convocation administration service. |
ConvocationBatchAdminSession |
getConvocationBatchAdminSessionForAcademy(Id academyId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk conferral
administration service.proxy
- a proxy ConferralBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConferralBatchAdmin()
is false
optional
- This method must be implemented if
supportsConferralBatchAdmin()
is true.
ConferralBatchAdminSession getConferralBatchAdminSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk conferral
administration service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConferralBatchAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk award
administration service.proxy
- a proxy AwardBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAwardBatchAdmin()
is false
optional
- This method must be implemented if
supportsAwardBatchAdmin()
is true.
AwardBatchAdminSession getAwardBatchAdminSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk award
administration service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy AwardBatchAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
convocation administration service.proxy
- a proxy ConvocationBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConvocationBatchAdmin()
is false
optional
- This method must be implemented if
supportsConvocationBatchAdmin()
is true.
ConvocationBatchAdminSession getConvocationBatchAdminSessionForAcademy(Id academyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
convocation administration service for the given academy.academyId
- the Id
of the Academy
proxy
- a proxy ConvocationBatchAdminSession
NotFoundException
- no Academy
found by
the given Id
NullArgumentException
- academyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk academy
administration service.proxy
- a proxy AcademyBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcademyBatchAdmin()
is false
optional
- This method must be implemented if
supportsAcademyBatchAdmin()
is true.