org.osid.course.registration.batch

Interface CourseRegistrationBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CourseRegistrationBatchProfile, OsidProfile, OsidProxyManager, Sourceable

public interface CourseRegistrationBatchProxyManager
extends OsidProxyManager, CourseRegistrationBatchProfile

The course registration batch proxy manager provides access to course registration 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:

• ActivityBundleBatchAdminSession: a session to create, modify and delete actvity bundles in bulk
• RegistrationBatchSession: a session to create, modify and delete registrations in bulk
• ActivityRegistrationBatchAdminSession: a session to create, modify and delete activity registrations in bulk

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBundleBatchAdminSession	getActivityBundleBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk activity bundle administration service.
ActivityBundleBatchAdminSession	getActivityBundleBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk activity bundle administration service for the given course catalog.
ActivityRegistrationBatchAdminSession	getActivityRegistrationBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk activity registration administration service.
ActivityRegistrationBatchAdminSession	getActivityRegistrationBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk activity registration administration service for the given course catalog.
RegistrationBatchAdminSession	getRegistrationBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk registration administration service.
RegistrationBatchAdminSession	getRegistrationBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk registration administration service for the given course catalog.

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.course.registration.batch.CourseRegistrationBatchProfile

supportsActivityBundleBatchAdmin, supportsActivityRegistrationBatchAdmin, supportsRegistrationBatchAdmin, 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

getActivityBundleBatchAdminSession

ActivityBundleBatchAdminSession getActivityBundleBatchAdminSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk activity bundle administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityBundleBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsActivityBundleBatchAdmin() is true.

getActivityBundleBatchAdminSessionForCourseCatalog

ActivityBundleBatchAdminSession getActivityBundleBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                                 Proxy proxy)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

Gets the OsidSession associated with the bulk activity bundle administration service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

an ActivityBundleBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityBundleBatchAdmin() and supportsVisibleFederation() are true

getRegistrationBatchAdminSession

RegistrationBatchAdminSession getRegistrationBatchAdminSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk registration administration service.

Parameters:

proxy - a proxy

Returns:

a RegistrationBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRegistrationBatchAdmin() is true.

getRegistrationBatchAdminSessionForCourseCatalog

RegistrationBatchAdminSession getRegistrationBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the bulk registration administration service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRegistrationBatchAdmin() and supportsVisibleFederation() are true

getActivityRegistrationBatchAdminSession

ActivityRegistrationBatchAdminSession getActivityRegistrationBatchAdminSession(Proxy proxy)
                                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk activity registration administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityRegistrationBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsActivityRegistrationBatchAdmin() is true.

getActivityRegistrationBatchAdminSessionForCourseCatalog

ActivityRegistrationBatchAdminSession getActivityRegistrationBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                                             Proxy proxy)
                                                                                               throws NotFoundException,
                                                                                                      OperationFailedException

Gets the OsidSession associated with the bulk activity registration administration service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

an ActivityRegistrationBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityRegistrationBatchAdmin() and supportsVisibleFederation() are true