org.osid.course.program.batch

Interface CourseProgramBatchManager

All Superinterfaces:

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

public interface CourseProgramBatchManager
extends OsidManager, CourseProgramBatchProfile

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

• ProgramBatchAdminSession: a session to create, modify and delete programs in bulk
• ProgramOfferingBatchAdminSession: a session to create, modify and delete program offerings in bulk
• CredentialBatchAdminSession: a session to create, modify and delete cerdentials in bulk
• EnrollmentBatchAdminSession: a session to create, modify and delete enrollments in bulk

Method Summary

Methods

Modifier and Type	Method and Description
CredentialBatchAdminSession	getCredentialBatchAdminSession() Gets the OsidSession associated with the bulk credential administration service.
CredentialBatchAdminSession	getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk credential administration service for the given course catalog.
EnrollmentBatchAdminSession	getEnrollmentBatchAdminSession() Gets the OsidSession associated with the bulk enrollment administration service.
EnrollmentBatchAdminSession	getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk enrollment administration service for the given course catalog.
ProgramBatchAdminSession	getProgramBatchAdminSession() Gets the OsidSession associated with the bulk program administration service.
ProgramBatchAdminSession	getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk program administration service for the given course catalog.
ProgramOfferingBatchAdminSession	getProgramOfferingBatchAdminSession() Gets the OsidSession associated with the bulk program offering administration service.
ProgramOfferingBatchAdminSession	getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk program offering 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.program.batch.CourseProgramBatchProfile

supportsCredentialBatchAdmin, supportsEnrollmentBatchAdmin, supportsProgramBatchAdmin, supportsProgramOfferingBatchAdmin, 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

getProgramBatchAdminSession

ProgramBatchAdminSession getProgramBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk program administration service.

Returns:

a ProgramBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramBatchAdmin() is false

Compliance:

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

getProgramBatchAdminSessionForCourseCatalog

ProgramBatchAdminSession getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ProgramBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingBatchAdminSession

ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSession()
                                                                     throws OperationFailedException

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

Returns:

a ProgramOfferingBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingBatchAdmin() is false

Compliance:

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

getProgramOfferingBatchAdminSessionForCourseCatalog

ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ProgramOfferingBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCredentialBatchAdminSession

CredentialBatchAdminSession getCredentialBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk credential administration service.

Returns:

a CredentialBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialBatchAdmin() is false

Compliance:

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

getCredentialBatchAdminSessionForCourseCatalog

CredentialBatchAdminSession getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CredentialBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentBatchAdminSession

EnrollmentBatchAdminSession getEnrollmentBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk enrollment administration service.

Returns:

an EnrollmentBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentBatchAdmin() is false

Compliance:

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

getEnrollmentBatchAdminSessionForCourseCatalog

EnrollmentBatchAdminSession getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an EnrollmentBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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