org.osid.recognition.batch

Interface RecognitionBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, 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 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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.recognition.batch.RecognitionBatchProfile

supportsAcademyBatchAdmin, supportsAwardBatchAdmin, supportsConferralBatchAdmin, supportsConvocationBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsConferralBatchAdmin() is 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 supportsConferralBatchAdmin() and supportsVisibleFederation() are 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 supportsAwardBatchAdmin() is 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 supportsAwardBatchAdmin() and supportsVisibleFederation() are 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 supportsConvocationBatchAdmin() is 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 supportsConvocationBatchAdmin() and supportsVisibleFederation() are 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 supportsAcademyBatchAdmin() is true.