Interface RecognitionBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, RecognitionBatchProfile, Sourceable

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface RecognitionBatchProfile

supportsAcademyBatchAdmin, supportsAwardBatchAdmin, supportsConferralBatchAdmin, supportsConvocationBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAcademyBatchAdmin()	Tests if bulk administration of academy is available.
boolean	supportsAwardBatchAdmin()	Tests if bulk administration of awards is available.
boolean	supportsConferralBatchAdmin()	Tests if bulk administration of conferrals is available.
boolean	supportsConvocationBatchAdmin()	Tests if bulk administration of convocations is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getConferralBatchAdminSession

ConferralBatchAdminSession getConferralBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk conferral administration service.

Returns:

a ConferralBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralBatchAdmin()} is {@code true} .

getConferralBatchAdminSessionForAcademy

ConferralBatchAdminSession getConferralBatchAdminSessionForAcademy(Id academyId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

academyId - the Id of the Academy

Returns:

a ConferralBatchAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConferralBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAwardBatchAdminSession

AwardBatchAdminSession getAwardBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk award administration service.

Returns:

an AwardBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardBatchAdmin()} is {@code true} .

getAwardBatchAdminSessionForAcademy

AwardBatchAdminSession getAwardBatchAdminSessionForAcademy(Id academyId)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

academyId - the Id of the Academy

Returns:

an AwardBatchAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAwardBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getConvocationBatchAdminSession

ConvocationBatchAdminSession getConvocationBatchAdminSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk convocation administration service.

Returns:

a ConvocationBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationBatchAdmin()} is {@code true} .

getConvocationBatchAdminSessionForAcademy

ConvocationBatchAdminSession getConvocationBatchAdminSessionForAcademy(Id academyId)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

academyId - the Id of the Academy

Returns:

a ConvocationBatchAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConvocationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsConvocationBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAcademyBatchAdminSession

AcademyBatchAdminSession getAcademyBatchAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk academy administration service.

Returns:

a AcademyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyBatchAdmin()} is {@code true} .