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 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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk program
administration service.proxy
- a proxy ProgramBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProgramBatchAdmin()
is false
optional
- This method must be implemented if
supportsProgramBatchAdmin()
is true.
ProgramBatchAdminSession getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk program
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy ProgramBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk program
offering administration service.proxy
- a proxy ProgramOfferingBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProgramOfferingBatchAdmin()
is false
optional
- This method must be implemented if
supportsProgramOfferingBatchAdmin()
is
true.
ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk program
offering administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy ProgramOfferingBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
credential administration service.proxy
- a proxy CredentialBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCredentialBatchAdmin()
is false
optional
- This method must be implemented if
supportsCredentialBatchAdmin()
is true.
CredentialBatchAdminSession getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
credential administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy CredentialBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
enrollment administration service.proxy
- a proxy EnrollmentBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEnrollmentBatchAdmin()
is false
optional
- This method must be implemented if
supportsEnrollmentBatchAdmin()
is true.
EnrollmentBatchAdminSession getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
enrollment administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy EnrollmentBatchAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEnrollmentBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEnrollmentBatchAdmin()
and
supportsVisibleFederation()
are true