org.osid.course.program.batch

Interface CourseProgramBatchProxyManager

All Superinterfaces:

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

public interface CourseProgramBatchProxyManager
extends OsidProxyManager, CourseProgramBatchProfile

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

• 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 credentials in bulk
• EnrollmentBatchAdminSession: a session to create, modify and delete enrollments in bulk

Method Summary

Methods

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

Gets the OsidSession associated with the bulk program administration service.

Parameters:

proxy - a proxy

Returns:

a ProgramBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a ProgramBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

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

Parameters:

proxy - a proxy

Returns:

a ProgramOfferingBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a ProgramOfferingBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

Gets the OsidSession associated with the bulk credential administration service.

Parameters:

proxy - a proxy

Returns:

a CredentialBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a CredentialBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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

Gets the OsidSession associated with the bulk enrollment administration service.

Parameters:

proxy - a proxy

Returns:

an EnrollmentBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

an EnrollmentBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

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