Interface ChecklistProxyManager
- All Superinterfaces:
AutoCloseable, ChecklistProfile, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
The checklist manager provides access to checklist sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager accept a Proxy for passing information
from a server environment. 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 TypeMethodDescriptiongetChecklistAdminSession(Proxy proxy) Gets theOsidSessionassociated with the checklist administrative service.Gets aChecklistBatchProxyManager.Gets theOsidSessionassociated with the checklist hierarchy design service.Gets theOsidSessionassociated with the checklist hierarchy service.getChecklistLookupSession(Proxy proxy) Gets theOsidSessionassociated with the checklist lookup service.Gets aChecklistMasonProxyManager.getChecklistNotificationSession(ChecklistReceiver checklistReceiver, Proxy proxy) Gets theOsidSessionassociated with the checklist notification service.getChecklistQuerySession(Proxy proxy) Gets theOsidSessionassociated with the checklist query service.getChecklistSearchSession(Proxy proxy) Gets theOsidSessionassociated with the checklist search service.getTodoAdminSession(Proxy proxy) Gets theOsidSessionassociated with the todo administration service.getTodoAdminSessionForChecklist(Id checklistId, Proxy proxy) Gets theOsidSessionassociated with the todo administration service for the given checklist.Gets the session for assigning todo to checklist mappings.getTodoChecklistSession(Proxy proxy) Gets the session for retrieving todo to checklist mappings.Gets the todo hierarchy design session.getTodoHierarchyDesignSessionForChecklist(Id checklistId, Proxy proxy) Gets the todo hierarchy design session for the given checklist.getTodoHierarchySession(Proxy proxy) Gets the todo hierarchy traversal session.getTodoHierarchySessionForChecklist(Id checklistId, Proxy proxy) Gets the todo hierarchy traversal session for the given checklist.getTodoLookupSession(Proxy proxy) Gets theOsidSessionassociated with the todo lookup service.getTodoLookupSessionForChecklist(Id checklistId, Proxy proxy) Gets theOsidSessionassociated with the todo lookup service for the given checklist.getTodoNotificationSession(TodoReceiver todoReceiver, Proxy proxy) Gets theOsidSessionassociated with the todo notification service.getTodoNotificationSessionForChecklist(TodoReceiver todoReceiver, Id checklistId, Proxy proxy) Gets theOsidSessionassociated with the todo notification service for the given checklist.getTodoQuerySession(Proxy proxy) Gets theOsidSessionassociated with the todo query service.getTodoQuerySessionForChecklist(Id checklistId, Proxy proxy) Gets theOsidSessionassociated with the todo query service for the given checklist.getTodoSearchSession(Proxy proxy) Gets theOsidSessionassociated with the todo search service.getTodoSearchSessionForChecklist(Id checklistId, Proxy proxy) Gets theOsidSessionassociated with the todo search service for the given checklist.getTodoSmartChecklistSession(Id checklistId, Proxy proxy) Gets the session for managing dynamic todo checklists 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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedChecklistrecord types.Gets the supported checklist search record types.Gets the supported priority types.Gets the supportedTodorecord types.Gets the supported todo search record types.booleanTests for the availability of a checklist administrative service for creating and deleting checklists.booleanTests for the availability of a checklist batch service.booleanTests for the availability of a checklist hierarchy traversal service.booleanTests for the availability of a checklist hierarchy design service.booleanTests for the availability of a checklist lookup service.booleanTests for the availability of a checklist mason service.booleanTests for the availability of a checklist notification service.booleanTests if querying checklists is available.booleansupportsChecklistRecordType(Type checklistRecordType) Tests if the givenChecklistrecord type is supported.booleanTests if searching for checklists is available.booleansupportsChecklistSearchRecordType(Type checklistSearchRecordType) Tests if the given checklist search record type is supported.booleansupportsPriorityType(Type priorityType) Tests if the given priority type is supported.booleanTests if managing todos is available.booleanTests if a todo to checklist lookup session is available.booleanTests if a todo to checklist assignment session is available.booleanTests if todo hierarchy traversal service is supported.booleanTests if a todo hierarchy design service is supported.booleanTests for the availability of a todo lookup service.booleanTests if todo notification is available.booleanTests if querying todos is available.booleansupportsTodoRecordType(Type todoRecordType) Tests if the givenTodorecord type is supported.booleanTests if searching for todos is available.booleansupportsTodoSearchRecordType(Type todoSearchRecordType) Tests if the given todo search record type is supported.booleanTests if a todo smart checklisting session is available.booleanTests if any checklist federation is exposed.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
-
getTodoLookupSession
Gets theOsidSessionassociated with the todo lookup service.- Parameters:
proxy- a proxy- Returns:
- a
TodoLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoLookup()} is {@code true} .
-
getTodoLookupSessionForChecklist
TodoLookupSession getTodoLookupSessionForChecklist(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the todo lookup service for the given checklist.- Parameters:
checklistId- theIdof theChecklistproxy- a proxy- Returns:
- a
TodoLookupSession - Throws:
NotFoundException- noChecklistfound by the givenIdNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoQuerySession
Gets theOsidSessionassociated with the todo query service.- Parameters:
proxy- a proxy- Returns:
- a
TodoQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoQuery()} is {@code true} .
-
getTodoQuerySessionForChecklist
TodoQuerySession getTodoQuerySessionForChecklist(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the todo query service for the given checklist.- Parameters:
checklistId- theIdof theChecklistproxy- a proxy- Returns:
- a
TodoQuerySession - Throws:
NotFoundException- noTodofound by the givenIdNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoSearchSession
Gets theOsidSessionassociated with the todo search service.- Parameters:
proxy- a proxy- Returns:
- a
TodoSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoSearch()} is {@code true} .
-
getTodoSearchSessionForChecklist
TodoSearchSession getTodoSearchSessionForChecklist(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the todo search service for the given checklist.- Parameters:
checklistId- theIdof theChecklistproxy- a proxy- Returns:
- a
TodoSearchSession - Throws:
NotFoundException- noTodofound by the givenIdNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoAdminSession
Gets theOsidSessionassociated with the todo administration service.- Parameters:
proxy- a proxy- Returns:
- a
TodoAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoAdmin()} is {@code true} .
-
getTodoAdminSessionForChecklist
TodoAdminSession getTodoAdminSessionForChecklist(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the todo administration service for the given checklist.- Parameters:
checklistId- theIdof theChecklistproxy- a proxy- Returns:
- a
TodoAdminSession - Throws:
NotFoundException- noTodofound by the givenIdNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoNotificationSession
TodoNotificationSession getTodoNotificationSession(TodoReceiver todoReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the todo notification service.- Parameters:
todoReceiver- the receiverproxy- a proxy- Returns:
- a
TodoNotificationSession - Throws:
NullArgumentException-todoReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoNotification()} is {@code true} .
-
getTodoNotificationSessionForChecklist
TodoNotificationSession getTodoNotificationSessionForChecklist(TodoReceiver todoReceiver, Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the todo notification service for the given checklist.- Parameters:
todoReceiver- the receiverchecklistId- theIdof theChecklistproxy- a proxy- Returns:
- a
TodoNotificationSession - Throws:
NotFoundException- noTodofound by the givenIdNullArgumentException-todoReceiver, checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoHierarchySession
Gets the todo hierarchy traversal session.- Parameters:
proxy- proxy- Returns:
a TodoHierarchySession- Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoHierarchy()} is {@code true} .
-
getTodoHierarchySessionForChecklist
TodoHierarchySession getTodoHierarchySessionForChecklist(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets the todo hierarchy traversal session for the given checklist.- Parameters:
checklistId- theIdof theChecklistproxy- proxy- Returns:
a TodoHierarchySession- Throws:
NotFoundException- no checklist found by the givenIdNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoHierarchy()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoHierarchy()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoHierarchyDesignSession
TodoHierarchyDesignSession getTodoHierarchyDesignSession(Proxy proxy) throws OperationFailedException Gets the todo hierarchy design session.- Parameters:
proxy- proxy- Returns:
- a
TodoHierarchyDesignSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoHierarchyDesign()} is {@code true} .
-
getTodoHierarchyDesignSessionForChecklist
TodoHierarchyDesignSession getTodoHierarchyDesignSessionForChecklist(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets the todo hierarchy design session for the given checklist.- Parameters:
checklistId- theIdof theChecklistproxy- proxy- Returns:
- a
TodoHierarchyDesignSession - Throws:
NotFoundException- no checklist found by the givenIdNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoHierarchyDesign()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true}
-
getTodoChecklistSession
Gets the session for retrieving todo to checklist mappings.- Parameters:
proxy- a proxy- Returns:
- a
TodoChecklistSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoChecklist()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoChecklist()} is {@code true} .
-
getTodoChecklistAssignmentSession
TodoChecklistAssignmentSession getTodoChecklistAssignmentSession(Proxy proxy) throws OperationFailedException Gets the session for assigning todo to checklist mappings.- Parameters:
proxy- a proxy- Returns:
- a
TodoChecklistAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoChecklistAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoChecklistAssignment()} is {@code true} .
-
getTodoSmartChecklistSession
TodoSmartChecklistSession getTodoSmartChecklistSession(Id checklistId, Proxy proxy) throws NotFoundException, OperationFailedException Gets the session for managing dynamic todo checklists for the given checklist.- Parameters:
checklistId- theIdof a checklistproxy- a proxy- Returns:
checklistIdnot found- Throws:
NotFoundException-checklistIdorproxyisnullNullArgumentException-checklistIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTodoSmartChecklist()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTodoSmartChecklist()} is {@code true} .
-
getChecklistLookupSession
Gets theOsidSessionassociated with the checklist lookup service.- Parameters:
proxy- a proxy- Returns:
- a
ChecklistLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistLookup()} is {@code true} .
-
getChecklistQuerySession
Gets theOsidSessionassociated with the checklist query service.- Parameters:
proxy- a proxy- Returns:
- a
ChecklistQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistQueryh()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistQuery()} is {@code true} .
-
getChecklistSearchSession
Gets theOsidSessionassociated with the checklist search service.- Parameters:
proxy- a proxy- Returns:
- a
ChecklistSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistSearch()} is {@code true} .
-
getChecklistAdminSession
Gets theOsidSessionassociated with the checklist administrative service.- Parameters:
proxy- a proxy- Returns:
- a
ChecklistAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistAdmin()} is {@code true} .
-
getChecklistNotificationSession
ChecklistNotificationSession getChecklistNotificationSession(ChecklistReceiver checklistReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the checklist notification service.- Parameters:
checklistReceiver- the receiverproxy- a proxy- Returns:
- a
ChecklistNotificationSession - Throws:
NullArgumentException-checklistReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistNotification()} is {@code true} .
-
getChecklistHierarchySession
Gets theOsidSessionassociated with the checklist hierarchy service.- Parameters:
proxy- a proxy- Returns:
- a
ChecklistHierarchySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistHierarchy()} is {@code true} .
-
getChecklistHierarchyDesignSession
ChecklistHierarchyDesignSession getChecklistHierarchyDesignSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the checklist hierarchy design service.- Parameters:
proxy- a proxy- Returns:
- a
ChecklistHierarchyDesignSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChecklistHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistHierarchyDesign()} is {@code true} .
-
getChecklistBatchProxyManager
Gets aChecklistBatchProxyManager.- Returns:
- a
ChecklistBatchProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsChecklistBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistBatch()} is {@code true} .
-
getChecklistMasonProxyManager
Gets aChecklistMasonProxyManager.- Returns:
- a
ChecklistMasonProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsChecklistMason()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChecklistMason()} is {@code true} .
-