org.osid.course.chronicle.batch

Interface CourseChronicleBatchProxyManager

All Superinterfaces:

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

public interface CourseChronicleBatchProxyManager
extends OsidProxyManager, CourseChronicleBatchProfile

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

• ProgramEntryBatchAdminSession: a session to create, modify and delete program entries in bulk
• CourseEntryBatchSession: a session to create, modify and delete course entries in bulk
• CredentialEntryBatchAdminSession: a session to create, modify and delete credential entries in bulk
• AssessmentEntryBatchAdminSession: a session to create, modify and delete assessment entries in bulk
• AwardEntryBatchAdminSession: a session to create, modify and delete award entries in bulk

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentEntryBatchAdminSession	getAssessmentEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk assessment entry administration service.
AssessmentEntryBatchAdminSession	getAssessmentEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk assessment entry administration service for the given course catalog.
AwardEntryBatchAdminSession	getAwardEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk award entry administration service.
AwardEntryBatchAdminSession	getAwardEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk award entry administration service for the given course catalog.
CourseEntryBatchAdminSession	getCourseEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk course entry administration service.
CourseEntryBatchAdminSession	getCourseEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk course entry administration service for the given course catalog.
CredentialEntryBatchAdminSession	getCredentialEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk credential entry administration service.
CredentialEntryBatchAdminSession	getCredentialEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk credential entry administration service for the given course catalog.
ProgramEntryBatchAdminSession	getProgramEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk program entry administration service.
ProgramEntryBatchAdminSession	getProgramEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the bulk program entry 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.chronicle.batch.CourseChronicleBatchProfile

supportsAssessmentEntryBatchAdmin, supportsAwardEntryBatchAdmin, supportsCourseEntryBatchAdmin, supportsCredentialEntryBatchAdmin, supportsProgramEntryBatchAdmin, 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

getProgramEntryBatchAdminSession

ProgramEntryBatchAdminSession getProgramEntryBatchAdminSession(Proxy proxy)
                                                               throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProgramEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryBatchAdmin() is false

Compliance:

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

getProgramEntryBatchAdminSessionForCourseCatalog

ProgramEntryBatchAdminSession getProgramEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a ProgramEntryBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntryBatchAdminSession

CourseEntryBatchAdminSession getCourseEntryBatchAdminSession(Proxy proxy)
                                                             throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CourseEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryBatchAdmin() is false

Compliance:

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

getCourseEntryBatchAdminSessionForCourseCatalog

CourseEntryBatchAdminSession getCourseEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a CourseEntryBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntryBatchAdminSession

CredentialEntryBatchAdminSession getCredentialEntryBatchAdminSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk credential entry administration service.

Parameters:

proxy - a proxy

Returns:

a CredentialEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryBatchAdmin() is false

Compliance:

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

getCredentialEntryBatchAdminSessionForCourseCatalog

CredentialEntryBatchAdminSession getCredentialEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a CredentialEntryBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntryBatchAdminSession

AssessmentEntryBatchAdminSession getAssessmentEntryBatchAdminSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk assessment entry administration service.

Parameters:

proxy - a proxy

Returns:

an AssessmentEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryBatchAdmin() is false

Compliance:

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

getAssessmentEntryBatchAdminSessionForCourseCatalog

AssessmentEntryBatchAdminSession getAssessmentEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

an AssessmentEntryBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntryBatchAdminSession

AwardEntryBatchAdminSession getAwardEntryBatchAdminSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk award entry administration service.

Parameters:

proxy - a proxy

Returns:

an AwardEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryBatchAdmin() is false

Compliance:

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

getAwardEntryBatchAdminSessionForCourseCatalog

AwardEntryBatchAdminSession getAwardEntryBatchAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

an AwardEntryBatchAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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