Interface ChecklistManager

All Superinterfaces:

AutoCloseable, ChecklistProfile, Closeable, OsidManager, 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

Modifier and Type	Method	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 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

Modifier and Type	Method	Description
TypeList	getChecklistRecordTypes()	Gets the supported Checklist record types.
TypeList	getChecklistSearchRecordTypes()	Gets the supported checklist search record types.
TypeList	getPriorityTypes()	Gets the supported priority types.
TypeList	getTodoRecordTypes()	Gets the supported Todo record types.
TypeList	getTodoSearchRecordTypes()	Gets the supported todo search record types.
boolean	supportsChecklistAdmin()	Tests for the availability of a checklist administrative service for creating and deleting checklists.
boolean	supportsChecklistBatch()	Tests for the availability of a checklist batch service.
boolean	supportsChecklistHierarchy()	Tests for the availability of a checklist hierarchy traversal service.
boolean	supportsChecklistHierarchyDesign()	Tests for the availability of a checklist hierarchy design service.
boolean	supportsChecklistLookup()	Tests for the availability of a checklist lookup service.
boolean	supportsChecklistMason()	Tests for the availability of a checklist mason service.
boolean	supportsChecklistNotification()	Tests for the availability of a checklist notification service.
boolean	supportsChecklistQuery()	Tests if querying checklists is available.
boolean	supportsChecklistRecordType(Type checklistRecordType)	Tests if the given Checklist record type is supported.
boolean	supportsChecklistSearch()	Tests if searching for checklists is available.
boolean	supportsChecklistSearchRecordType(Type checklistSearchRecordType)	Tests if the given checklist search record type is supported.
boolean	supportsPriorityType(Type priorityType)	Tests if the given priority type is supported.
boolean	supportsTodoAdmin()	Tests if managing todos is available.
boolean	supportsTodoChecklist()	Tests if a todo to checklist lookup session is available.
boolean	supportsTodoChecklistAssignment()	Tests if a todo to checklist assignment session is available.
boolean	supportsTodoHierarchy()	Tests if todo hierarchy traversal service is supported.
boolean	supportsTodoHierarchyDesign()	Tests if a todo hierarchy design service is supported.
boolean	supportsTodoLookup()	Tests for the availability of a todo lookup service.
boolean	supportsTodoNotification()	Tests if todo notification is available.
boolean	supportsTodoQuery()	Tests if querying todos is available.
boolean	supportsTodoRecordType(Type todoRecordType)	Tests if the given Todo record type is supported.
boolean	supportsTodoSearch()	Tests if searching for todos is available.
boolean	supportsTodoSearchRecordType(Type todoSearchRecordType)	Tests if the given todo search record type is supported.
boolean	supportsTodoSmartChecklist()	Tests if a todo smart checklisting session is available.
boolean	supportsVisibleFederation()	Tests if any checklist federation is exposed.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsTodoLookup()} is {@code 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 {@code supportsTodoLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoQuery()} is {@code 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 {@code supportsTodoQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoSearch()} is {@code 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 {@code supportsTodoSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoAdmin()} is {@code 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 {@code supportsTodoAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoNotification()} is {@code 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 {@code supportsTodoNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoHierarchy()} is {@code 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 {@code supportsTodoHierarchy()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoHierarchyDesign()} is {@code 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 {@code supportsTodoHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoChecklist()} is {@code 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 {@code supportsTodoChecklistAssignment()} is {@code 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 {@code supportsTodoSmartChecklist()} is {@code 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 {@code supportsChecklistLookup()} is {@code 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 {@code supportsChecklistQuery()} is {@code 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 {@code supportsChecklistSearch()} is {@code 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 {@code supportsChecklistAdmin()} is {@code 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 {@code supportsChecklistNotification()} is {@code 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 {@code supportsChecklistHierarchy()} is {@code 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 {@code supportsChecklistHierarchyDesign()} is {@code 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 {@code supportsChecklistBatch()} is {@code 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 {@code supportsChecklistMason()} is {@code true} .