org.osid.course.batch

Interface CourseBatchProxyManager

All Superinterfaces:

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

public interface CourseBatchProxyManager
extends OsidProxyManager, CourseBatchProfile

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

• 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(Proxy proxy) Gets the OsidSession associated with the bulk activity administration service.
ActivityBatchAdminSession	getActivityBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk activity administration service for the given course catalog
ActivityUnitBatchAdminSession	getActivityUnitBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk activity unit administration service.
ActivityUnitBatchAdminSession	getActivityUnitBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk activity unit administration service for the given course catalog
CourseBatchAdminSession	getCourseBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk course administration service.
CourseBatchAdminSession	getCourseBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk course administration service for the given course catalog
CourseCatalogBatchAdminSession	getCourseCatalogBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk course catalog administration service.
CourseOfferingBatchAdminSession	getCourseOfferingBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk course offering administration service.
CourseOfferingBatchAdminSession	getCourseOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk course offering administration service for the given course catalog
TermBatchAdminSession	getTermBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk term administration service.
TermBatchAdminSession	getTermBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk term 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.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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk course administration service.

Parameters:

proxy - a proxy

Returns:

a CourseBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a CourseBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

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

Parameters:

proxy - a proxy

Returns:

an ActivityUnitBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

an ActivityUnitBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

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

Parameters:

proxy - a proxy

Returns:

a CourseOfferingBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a CourseOfferingBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

Gets the OsidSession associated with the bulk activity administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

Gets the OsidSession associated with the bulk term administration service.

Parameters:

proxy - a proxy

Returns:

a TermBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a TermBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

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

Parameters:

proxy - a proxy

Returns:

a CourseCatalogBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogBatchAdmin() is false

Compliance:

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