Interface RecognitionBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, RecognitionBatchProfile, Sourceable

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. 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

RecognitionBatchProxyManager may be accessed by multiple processing threads.

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface RecognitionBatchProfile

supportsAcademyBatchAdmin, supportsAwardBatchAdmin, supportsConferralBatchAdmin, supportsConvocationBatchAdmin, supportsVisibleFederation

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getConferralBatchAdminSession

ConferralBatchAdminSession getConferralBatchAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk conferral administration service.

Parameters:

proxy - a proxy

Returns:

a ConferralBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConferralBatchAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk award administration service.

Parameters:

proxy - a proxy

Returns:

an AwardBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

an AwardBatchAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk convocation administration service.

Parameters:

proxy - a proxy

Returns:

a ConvocationBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

academyId - the Id of the Academy

proxy - a proxy

Returns:

a ConvocationBatchAdminSession

Throws:

NotFoundException - no Academy found by the given Id

NullArgumentException - academyId or proxy 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(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk academy administration service.

Parameters:

proxy - a proxy

Returns:

a AcademyBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademyBatchAdmin() is false

Compliance:

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