org.osid.course.syllabus.batch

Interface CourseSyllabusBatchManager

All Superinterfaces:

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

public interface CourseSyllabusBatchManager
extends OsidManager, CourseSyllabusBatchProfile

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

• SyllabusBatchSession: a session to create, modify and delete syllabi in bulk
• ModuleBatchSession: a session to create, modify and delete cerdentials in bulk
• DocetBatchAdminSession: a session to create, modify and delete docets in bulk

Method Summary

Methods

Modifier and Type	Method and Description
DocetBatchAdminSession	getDocetBatchAdminSession() Gets the OsidSession associated with the bulk docet administration service.
DocetBatchAdminSession	getDocetBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk docet administration service for the given course catalog.
ModuleBatchAdminSession	getModuleBatchAdminSession() Gets the OsidSession associated with the bulk module administration service.
ModuleBatchAdminSession	getModuleBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk module administration service for the given course catalog.
SyllabusBatchAdminSession	getSyllabusBatchAdminSession() Gets the OsidSession associated with the bulk syllabus administration service.
SyllabusBatchAdminSession	getSyllabusBatchAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the bulk syllabus 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.syllabus.batch.CourseSyllabusBatchProfile

supportsDocetBatchAdmin, supportsModuleBatchAdmin, supportsSyllabusBatchAdmin, 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

getSyllabusBatchAdminSession

SyllabusBatchAdminSession getSyllabusBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk syllabus administration service.

Returns:

a SyllabusBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusBatchAdmin() is false

Compliance:

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

getSyllabusBatchAdminSessionForCourseCatalog

SyllabusBatchAdminSession getSyllabusBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a SyllabusBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getModuleBatchAdminSession

ModuleBatchAdminSession getModuleBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk module administration service.

Returns:

a ModuleBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleBatchAdmin() is false

Compliance:

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

getModuleBatchAdminSessionForCourseCatalog

ModuleBatchAdminSession getModuleBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ModuleBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getDocetBatchAdminSession

DocetBatchAdminSession getDocetBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk docet administration service.

Returns:

an DocetBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetBatchAdmin() is false

Compliance:

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

getDocetBatchAdminSessionForCourseCatalog

DocetBatchAdminSession getDocetBatchAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an DocetBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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