Interface CourseSyllabusBatchProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, CourseSyllabusBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
public interface CourseSyllabusBatchProxyManager
extends OsidProxyManager, CourseSyllabusBatchProfile
The course syllabus batch proxy manager provides access to course
syllabus 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:
-
SyllabusBatchSession: a session to create, modify and delete syllabi in bulk -
ModuleBatchSession: a session to create, modify and delete modules in bulk -
DocetBatchAdminSession: a session to create, modify and delete docets in bulk
-
Method Summary
Modifier and TypeMethodDescriptiongetDocetBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk docet administration service.getDocetBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets theOsidSessionassociated with the bulk docet administration service for the given course catalog.getModuleBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk module administration service.getModuleBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets theOsidSessionassociated with the bulk module administration service for the given course catalog.Gets theOsidSessionassociated with the bulk syllabus administration service.getSyllabusBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets theOsidSessionassociated with the bulk syllabus administration service for the given course catalog.Methods inherited from interface CourseSyllabusBatchProfile
supportsDocetBatchAdmin, supportsModuleBatchAdmin, supportsSyllabusBatchAdmin, supportsVisibleFederationModifier and TypeMethodDescriptionbooleanTests if bulk administration of docets is available.booleanTests if bulk administration of modules is available.booleanTests if bulk administration of syllabi is available.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getSyllabusBatchAdminSession
Gets theOsidSessionassociated with the bulk syllabus administration service.- Parameters:
proxy- a proxy- Returns:
- a
SyllabusBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSyllabusBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSyllabusBatchAdmin()} is {@code true} .
-
getSyllabusBatchAdminSessionForCourseCatalog
SyllabusBatchAdminSession getSyllabusBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk syllabus administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalogproxy- a proxy- Returns:
- a
SyllabusBatchAdminSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSyllabusBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSyllabusBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getModuleBatchAdminSession
Gets theOsidSessionassociated with the bulk module administration service.- Parameters:
proxy- a proxy- Returns:
- a
ModuleBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsModuleBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsModuleBatchAdmin()} is {@code true} .
-
getModuleBatchAdminSessionForCourseCatalog
ModuleBatchAdminSession getModuleBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk module administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalogproxy- a proxy- Returns:
- a
ModuleBatchAdminSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsModuleBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsModuleBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getDocetBatchAdminSession
Gets theOsidSessionassociated with the bulk docet administration service.- Parameters:
proxy- a proxy- Returns:
- an
DocetBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDocetBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDocetBatchAdmin()} is {@code true} .
-
getDocetBatchAdminSessionForCourseCatalog
DocetBatchAdminSession getDocetBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk docet administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalogproxy- a proxy- Returns:
- an
DocetBatchAdminSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDocetBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDocetBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-