public interface CourseProgramBatchManager extends OsidManager, CourseProgramBatchProfile
The course program batch manager provides access to course program batch sessions and provides interoperability tests for various aspects of this service. 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 cerdentials in bulk EnrollmentBatchAdminSession:
a session to create,
modify and delete enrollments in bulk Modifier and Type | Method and Description |
---|---|
CredentialBatchAdminSession |
getCredentialBatchAdminSession()
Gets the
OsidSession associated with the bulk
credential administration service. |
CredentialBatchAdminSession |
getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the bulk
credential administration service for the given course catalog. |
EnrollmentBatchAdminSession |
getEnrollmentBatchAdminSession()
Gets the
OsidSession associated with the bulk
enrollment administration service. |
EnrollmentBatchAdminSession |
getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the bulk
enrollment administration service for the given course catalog. |
ProgramBatchAdminSession |
getProgramBatchAdminSession()
Gets the
OsidSession associated with the bulk program
administration service. |
ProgramBatchAdminSession |
getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the bulk program
administration service for the given course catalog. |
ProgramOfferingBatchAdminSession |
getProgramOfferingBatchAdminSession()
Gets the
OsidSession associated with the bulk program
offering administration service. |
ProgramOfferingBatchAdminSession |
getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the bulk program
offering administration service for the given course catalog. |
changeBranch, initialize, rollbackService
close
supportsCredentialBatchAdmin, supportsEnrollmentBatchAdmin, supportsProgramBatchAdmin, supportsProgramOfferingBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProgramBatchAdminSession getProgramBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk program
administration service. ProgramBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProgramBatchAdmin()
is false
optional
- This method must be implemented if
supportsProgramBatchAdmin()
is true.
ProgramBatchAdminSession getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk program
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
ProgramBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProgramBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProgramBatchAdmin()
and
supportsVisibleFederation()
are true
ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk program
offering administration service. ProgramOfferingBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProgramOfferingBatchAdmin()
is false
optional
- This method must be implemented if
supportsProgramOfferingBatchAdmin()
is
true.
ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk program
offering administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
ProgramOfferingBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProgramOfferingBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProgramOfferingBatchAdmin()
and
supportsVisibleFederation()
are true
CredentialBatchAdminSession getCredentialBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
credential administration service. CredentialBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCredentialBatchAdmin()
is false
optional
- This method must be implemented if
supportsCredentialBatchAdmin()
is true.
CredentialBatchAdminSession getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
credential administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
CredentialBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCredentialBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCredentialBatchAdmin()
and
supportsVisibleFederation()
are true
EnrollmentBatchAdminSession getEnrollmentBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
enrollment administration service. EnrollmentBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEnrollmentBatchAdmin()
is false
optional
- This method must be implemented if
supportsEnrollmentBatchAdmin()
is true.
EnrollmentBatchAdminSession getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
enrollment administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
EnrollmentBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEnrollmentBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEnrollmentBatchAdmin()
and
supportsVisibleFederation()
are true