org.osid.course.syllabus.batch

Interface CourseSyllabusBatchProxyManager

All Superinterfaces:

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

public interface CourseSyllabusBatchProxyManager
extends OsidProxyManager, CourseSyllabusBatchProfile

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

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

Method Summary

Methods

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

Gets the OsidSession associated with the bulk syllabus administration service.

Parameters:

proxy - a proxy

Returns:

a SyllabusBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       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

proxy - a proxy

Returns:

a SyllabusBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

Gets the OsidSession associated with the bulk module administration service.

Parameters:

proxy - a proxy

Returns:

a ModuleBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                 Proxy proxy)
                                                                   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

proxy - a proxy

Returns:

a ModuleBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

Gets the OsidSession associated with the bulk docet administration service.

Parameters:

proxy - a proxy

Returns:

an DocetBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 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

proxy - a proxy

Returns:

an DocetBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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