org.osid.course.registration.batch

Interface CourseRegistrationBatchManager

All Superinterfaces:

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

public interface CourseRegistrationBatchManager
extends OsidManager, CourseRegistrationBatchProfile

The course registration batch manager provides access to course registration batch sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the bulk activity bundle administration service.
ActivityBundleBatchAdminSession	getActivityBundleBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk activity bundle administration service for the given course catalog.
ActivityRegistrationBatchAdminSession	getActivityRegistrationBatchAdminSession() Gets the OsidSession associated with the bulk activity registration administration service.
ActivityRegistrationBatchAdminSession	getActivityRegistrationBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk activity registration administration service for the given course catalog.
RegistrationBatchAdminSession	getRegistrationBatchAdminSession() Gets the OsidSession associated with the bulk registration administration service.
RegistrationBatchAdminSession	getRegistrationBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk registration administration service for the given course catalog.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                                   throws OperationFailedException

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

Returns:

an ActivityBundleBatchAdminSession

Throws:

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

Returns:

an ActivityBundleBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId 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()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk registration administration service.

Returns:

a RegistrationBatchAdminSession

Throws:

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

Returns:

a RegistrationBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId 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()
                                                                               throws OperationFailedException

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

Returns:

an ActivityRegistrationBatchAdminSession

Throws:

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

Returns:

an ActivityRegistrationBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId 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