org.osid.course.batch

Interface CourseBatchManager

All Superinterfaces:

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

public interface CourseBatchManager
extends OsidManager, CourseBatchProfile

The course batch manager provides access to course batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• CourseBatchAdminSession: a session to create, modify and delete courses in bulk
• ActivityUnitBatchAdminSession: a session to create, modify and delete activity units in bulk
• CourseOfferingBatchSession: a session to create, modify and delete course offerings in bulk
• ActivityBatchAdminSession: a session to create, modify and delete activities in bulk
• TermBatchAdminSession: a session to create, modify and delete terms in bulk
• CourseCatalogBatchAdminSession: a session to create, modify and delete course catalogs in bulk

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBatchAdminSession	getActivityBatchAdminSession() Gets the OsidSession associated with the bulk activity administration service.
ActivityBatchAdminSession	getActivityBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk activity administration service for the given course catalog
ActivityUnitBatchAdminSession	getActivityUnitBatchAdminSession() Gets the OsidSession associated with the bulk activity unit administration service.
ActivityUnitBatchAdminSession	getActivityUnitBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk activity unit administration service for the given course catalog
CourseBatchAdminSession	getCourseBatchAdminSession() Gets the OsidSession associated with the bulk course administration service.
CourseBatchAdminSession	getCourseBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk course administration service for the given course catalog
CourseCatalogBatchAdminSession	getCourseCatalogBatchAdminSession() Gets the OsidSession associated with the bulk course catalog administration service.
CourseOfferingBatchAdminSession	getCourseOfferingBatchAdminSession() Gets the OsidSession associated with the bulk course offering administration service.
CourseOfferingBatchAdminSession	getCourseOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk course offering administration service for the given course catalog
TermBatchAdminSession	getTermBatchAdminSession() Gets the OsidSession associated with the bulk term administration service.
TermBatchAdminSession	getTermBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk term 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.batch.CourseBatchProfile

supportsActivityBatchAdmin, supportsActivityUnitBatchAdmin, supportsCourseBatchAdmin, supportsCourseCatalogBatchAdmin, supportsCourseOfferingBatchAdmin, supportsTermBatchAdmin, 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

getCourseBatchAdminSession

CourseBatchAdminSession getCourseBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk course administration service.

Returns:

a CourseBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseBatchAdmin() is false

Compliance:

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

getCourseBatchAdminSessionForCourseCatalog

CourseBatchAdminSession getCourseBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitBatchAdminSession

ActivityUnitBatchAdminSession getActivityUnitBatchAdminSession()
                                                               throws OperationFailedException

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

Returns:

an ActivityUnitBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitBatchAdmin() is false

Compliance:

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

getActivityUnitBatchAdminSessionForCourseCatalog

ActivityUnitBatchAdminSession getActivityUnitBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityUnitBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingBatchAdminSession

CourseOfferingBatchAdminSession getCourseOfferingBatchAdminSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk course offering administration service.

Returns:

a CourseOfferingBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingBatchAdmin() is false

Compliance:

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

getCourseOfferingBatchAdminSessionForCourseCatalog

CourseOfferingBatchAdminSession getCourseOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseOfferingBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityBatchAdminSession

ActivityBatchAdminSession getActivityBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk activity administration service.

Returns:

an ActivityBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() is false

Compliance:

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

getActivityBatchAdminSessionForCourseCatalog

ActivityBatchAdminSession getActivityBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getTermBatchAdminSession

TermBatchAdminSession getTermBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk term administration service.

Returns:

a TermBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermBatchAdmin() is false

Compliance:

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

getTermBatchAdminSessionForCourseCatalog

TermBatchAdminSession getTermBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseCatalogBatchAdminSession

CourseCatalogBatchAdminSession getCourseCatalogBatchAdminSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk course catalog administration service.

Returns:

a CourseCatalogBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogBatchAdmin() is false

Compliance:

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