org.osid.checklist

Interface ChecklistManager

All Superinterfaces:

java.lang.AutoCloseable, ChecklistProfile, java.io.Closeable, OsidManager, OsidProfile, Sourceable

public interface ChecklistManager
extends OsidManager, ChecklistProfile

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

• TodoLookupSession: a session to lookup todos
• TodoQuerySession: a session to query todos
• TodoSearchSession: a session to search todos
• TodoAdminSession: a session to manage todos
• TodoNotificationSession: a session to subscribe to notifications of todo changes
• TodoHierarchySession: a session to traverse a hierarchy of todos
• TodoHierarchyDesignSession: a session to manage a todo hierarchy
• TodoChecklistSession: a session for looking up todo and checklist mappings
• TodoChecklistAssignmentSession: a session for managing todo and checklist mappings
• TodoSmartChecklistSession: a session to manage dynamic todo checklists
• ChecklistLookupSession: a session to retrieve checklists
• ChecklistQuerySession: a session to query checklists
• ChecklistSearchSession: a session to search for checklists
• ChecklistAdminSession: a session to create, update and delete checklists
• ChecklistNotificationSession: a session to receive notifications for changes in checklists
• ChecklistHierarchyTraversalSession: a session to traverse hierarchies of checklists
• ChecklistHierarchyDesignSession: a session to manage hierarchies of checklists

The todoing manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Methods

Modifier and Type	Method and Description
ChecklistAdminSession	getChecklistAdminSession() Gets the OsidSession associated with the checklist administrative service.
ChecklistBatchManager	getChecklistBatchManager() Gets a ChecklistBatchManager.
ChecklistHierarchyDesignSession	getChecklistHierarchyDesignSession() Gets the OsidSession associated with the checklist hierarchy design service.
ChecklistHierarchySession	getChecklistHierarchySession() Gets the OsidSession associated with the checklist hierarchy service.
ChecklistLookupSession	getChecklistLookupSession() Gets the OsidSession associated with the checklist lookup service.
ChecklistMasonManager	getChecklistMasonManager() Gets a ChecklistMasonManager.
ChecklistNotificationSession	getChecklistNotificationSession(ChecklistReceiver checklistReceiver) Gets the OsidSession associated with the checklist notification service.
ChecklistQuerySession	getChecklistQuerySession() Gets the OsidSession associated with the checklist query service.
ChecklistSearchSession	getChecklistSearchSession() Gets the OsidSession associated with the checklist search service.
TodoAdminSession	getTodoAdminSession() Gets the OsidSession associated with the todo administration service.
TodoAdminSession	getTodoAdminSessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo administration service for the given checklist.
TodoChecklistAssignmentSession	getTodoChecklistAssignmentSession() Gets the session for assigning todo to checklist mappings.
TodoChecklistSession	getTodoChecklistSession() Gets the session for retrieving todo to checklist mappings.
TodoHierarchyDesignSession	getTodoHierarchyDesignSession() Gets the todo hierarchy design session.
TodoHierarchyDesignSession	getTodoHierarchyDesignSessionForChecklist(Id businessId) Gets the todo hierarchy design session for the given checklist.
TodoHierarchySession	getTodoHierarchySession() Gets the todo hierarchy traversal session.
TodoHierarchySession	getTodoHierarchySessionForChecklist(Id checklistId) Gets the todo hierarchy traversal session for the given checklist.
TodoLookupSession	getTodoLookupSession() Gets the OsidSession associated with the todo lookup service.
TodoLookupSession	getTodoLookupSessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo lookup service for the given checklist.
TodoNotificationSession	getTodoNotificationSession(TodoReceiver todoReceiver) Gets the OsidSession associated with the todo notification service.
TodoNotificationSession	getTodoNotificationSessionForChecklist(TodoReceiver todoReceiver, Id checklistId) Gets the OsidSession associated with the todo notification service for the given checklist.
TodoQuerySession	getTodoQuerySession() Gets the OsidSession associated with the todo query service.
TodoQuerySession	getTodoQuerySessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo query service for the given checklist.
TodoSearchSession	getTodoSearchSession() Gets the OsidSession associated with the todo search service.
TodoSearchSession	getTodoSearchSessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo search service for the given checklist.
TodoSmartChecklistSession	getTodoSmartChecklistSession(Id checklistId) Gets the session associated with the todo smart checklist for the given checklist.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.checklist.ChecklistProfile

getChecklistRecordTypes, getChecklistSearchRecordTypes, getPriorityTypes, getTodoRecordTypes, getTodoSearchRecordTypes, supportsChecklistAdmin, supportsChecklistBatch, supportsChecklistHierarchy, supportsChecklistHierarchyDesign, supportsChecklistLookup, supportsChecklistMason, supportsChecklistNotification, supportsChecklistQuery, supportsChecklistRecordType, supportsChecklistSearch, supportsChecklistSearchRecordType, supportsPriorityType, supportsTodoAdmin, supportsTodoChecklist, supportsTodoChecklistAssignment, supportsTodoHierarchy, supportsTodoHierarchyDesign, supportsTodoLookup, supportsTodoNotification, supportsTodoQuery, supportsTodoRecordType, supportsTodoSearch, supportsTodoSearchRecordType, supportsTodoSmartChecklist, 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

getTodoLookupSession

TodoLookupSession getTodoLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the todo lookup service.

Returns:

a TodoLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoLookup() is false

Compliance:

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

getTodoLookupSessionForChecklist

TodoLookupSession getTodoLookupSessionForChecklist(Id checklistId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the todo lookup service for the given checklist.

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoLookupSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoLookup() or supportsVisibleFederation() is false

Compliance:

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

getTodoQuerySession

TodoQuerySession getTodoQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the todo query service.

Returns:

a TodoQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoQuery() is false

Compliance:

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

getTodoQuerySessionForChecklist

TodoQuerySession getTodoQuerySessionForChecklist(Id checklistId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the todo query service for the given checklist.

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoQuerySession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoQuery() or supportsVisibleFederation() is false

Compliance:

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

getTodoSearchSession

TodoSearchSession getTodoSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the todo search service.

Returns:

a TodoSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoSearch() is false

Compliance:

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

getTodoSearchSessionForChecklist

TodoSearchSession getTodoSearchSessionForChecklist(Id checklistId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the todo search service for the given checklist.

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoSearchSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoSearch() or supportsVisibleFederation() is false

Compliance:

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

getTodoAdminSession

TodoAdminSession getTodoAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the todo administration service.

Returns:

a TodoAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoAdmin() is false

Compliance:

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

getTodoAdminSessionForChecklist

TodoAdminSession getTodoAdminSessionForChecklist(Id checklistId)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoAdminSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoAdmin() or supportsVisibleFederation() is false

Compliance:

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

getTodoNotificationSession

TodoNotificationSession getTodoNotificationSession(TodoReceiver todoReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the todo notification service.

Parameters:

todoReceiver - the receiver

Returns:

a TodoNotificationSession

Throws:

NullArgumentException - todoReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoNotification() is false

Compliance:

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

getTodoNotificationSessionForChecklist

TodoNotificationSession getTodoNotificationSessionForChecklist(TodoReceiver todoReceiver,
                                                             Id checklistId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the todo notification service for the given checklist.

Parameters:

todoReceiver - the receiver

checklistId - the Id of the Checklist

Returns:

a TodoNotificationSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - todoReceiver or checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoNotification() or supportsVisibleFederation() is false

Compliance:

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

getTodoHierarchySession

TodoHierarchySession getTodoHierarchySession()
                                             throws OperationFailedException

Gets the todo hierarchy traversal session.

Returns:

a TodoHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoHierarchy() is false

Compliance:

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

getTodoHierarchySessionForChecklist

TodoHierarchySession getTodoHierarchySessionForChecklist(Id checklistId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the todo hierarchy traversal session for the given checklist.

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoHierarchySession

Throws:

NotFoundException - no checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoHierarchy() or supportsVisibleFederation() is false

Compliance:

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

getTodoHierarchyDesignSession

TodoHierarchyDesignSession getTodoHierarchyDesignSession()
                                                         throws OperationFailedException

Gets the todo hierarchy design session.

Returns:

a TodoHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoHierarchyDesign() is false

Compliance:

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

getTodoHierarchyDesignSessionForChecklist

TodoHierarchyDesignSession getTodoHierarchyDesignSessionForChecklist(Id businessId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the todo hierarchy design session for the given checklist.

Parameters:

businessId - the Id of the Checklist

Returns:

a TodoHierarchyDesignSession

Throws:

NotFoundException - no checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

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

getTodoChecklistSession

TodoChecklistSession getTodoChecklistSession()
                                             throws OperationFailedException

Gets the session for retrieving todo to checklist mappings.

Returns:

a TodoChecklistSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoChecklist() is false

Compliance:

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

getTodoChecklistAssignmentSession

TodoChecklistAssignmentSession getTodoChecklistAssignmentSession()
                                                                 throws OperationFailedException

Gets the session for assigning todo to checklist mappings.

Returns:

a TodoChecklistAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoChecklistAssignment() is false

Compliance:

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

getTodoSmartChecklistSession

TodoSmartChecklistSession getTodoSmartChecklistSession(Id checklistId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session associated with the todo smart checklist for the given checklist.

Parameters:

checklistId - the Id of the checklist

Returns:

a TodoSmartChecklistSession

Throws:

NotFoundException - checklistId not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoSmartChecklist() is false

Compliance:

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

getChecklistLookupSession

ChecklistLookupSession getChecklistLookupSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the checklist lookup service.

Returns:

a ChecklistLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistLookup() is false

Compliance:

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

getChecklistQuerySession

ChecklistQuerySession getChecklistQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the checklist query service.

Returns:

a ChecklistQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistQuery() is false

Compliance:

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

getChecklistSearchSession

ChecklistSearchSession getChecklistSearchSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the checklist search service.

Returns:

a ChecklistSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistSearch() is false

Compliance:

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

getChecklistAdminSession

ChecklistAdminSession getChecklistAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the checklist administrative service.

Returns:

a ChecklistAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistAdmin() is false

Compliance:

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

getChecklistNotificationSession

ChecklistNotificationSession getChecklistNotificationSession(ChecklistReceiver checklistReceiver)
                                                             throws OperationFailedException

Gets the OsidSession associated with the checklist notification service.

Parameters:

checklistReceiver - the receiver

Returns:

a ChecklistNotificationSession

Throws:

NullArgumentException - checklistReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistNotification() is false

Compliance:

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

getChecklistHierarchySession

ChecklistHierarchySession getChecklistHierarchySession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the checklist hierarchy service.

Returns:

a ChecklistHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistHierarchy() is false

Compliance:

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

getChecklistHierarchyDesignSession

ChecklistHierarchyDesignSession getChecklistHierarchyDesignSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the checklist hierarchy design service.

Returns:

a ChecklistHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistHierarchyDesign() is false

Compliance:

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

getChecklistBatchManager

ChecklistBatchManager getChecklistBatchManager()
                                               throws OperationFailedException

Gets a ChecklistBatchManager.

Returns:

a ChecklistBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistBatch() is false

Compliance:

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

getChecklistMasonManager

ChecklistMasonManager getChecklistMasonManager()
                                               throws OperationFailedException

Gets a ChecklistMasonManager.

Returns:

a ChecklistMasonManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistMason() is false

Compliance:

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