Interface ChecklistBatchManager

All Superinterfaces:

AutoCloseable, ChecklistBatchProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface ChecklistBatchManager
extends OsidManager, ChecklistBatchProfile

The checklist batch manager provides access to checklist batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• TodoBatchSession: a session to create, modify and delete todos in bulk
• ChecklistBatchAdminSession: a session to create, modify and delete checklists in bulk

ChecklistBatchManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
ChecklistBatchAdminSession	getChecklistBatchAdminSession()	Gets the OsidSession associated with the bulk checklist administration service.
TodoBatchAdminSession	getTodoBatchAdminSession()	Gets the OsidSession associated with the bulk todo administration service.
TodoBatchAdminSession	getTodoBatchAdminSessionForChecklist(Id checklistId)	Gets the OsidSession associated with the bulk todo administration service for the given checklist.

Methods inherited from interface ChecklistBatchProfile

supportsChecklistBatchAdmin, supportsTodoBatchAdmin, supportsVisibleFederation

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getTodoBatchAdminSession

TodoBatchAdminSession getTodoBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk todo administration service.

Returns:

a TodoBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsTodoBatchAdmin()} is {@code true}.

getTodoBatchAdminSessionForChecklist

TodoBatchAdminSession getTodoBatchAdminSessionForChecklist(Id checklistId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk todo administration service for the given checklist.

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoBatchAdminSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTodoBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getChecklistBatchAdminSession

ChecklistBatchAdminSession getChecklistBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk checklist administration service.

Returns:

a ChecklistBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsChecklistBatchAdmin()} is {@code true}.