org.osid.checklist

Interface ChecklistProxyManager

All Superinterfaces:

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

public interface ChecklistProxyManager
extends OsidProxyManager, ChecklistProfile

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

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the todo lookup service.

Parameters:

proxy - a proxy

Returns:

a TodoLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoLookupSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the todo query service.

Parameters:

proxy - a proxy

Returns:

a TodoQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoQuerySession

Throws:

NotFoundException - no Todo found by the given Id

NullArgumentException - checklistId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the todo search service.

Parameters:

proxy - a proxy

Returns:

a TodoSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoSearchSession

Throws:

NotFoundException - no Todo found by the given Id

NullArgumentException - checklistId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the todo administration service.

Parameters:

proxy - a proxy

Returns:

a TodoAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoAdminSession

Throws:

NotFoundException - no Todo found by the given Id

NullArgumentException - checklistId or proxy 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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the todo notification service.

Parameters:

todoReceiver - the receiver

proxy - a proxy

Returns:

a TodoNotificationSession

Throws:

NullArgumentException - todoReceiver or proxy 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,
                                                             Proxy proxy)
                                                               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

proxy - a proxy

Returns:

a TodoNotificationSession

Throws:

NotFoundException - no Todo found by the given Id

NullArgumentException - todoReceiver, checklistId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the todo hierarchy traversal session.

Parameters:

proxy - proxy

Returns:

a TodoHierarchySession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the todo hierarchy traversal session for the given checklist.

Parameters:

checklistId - the Id of the Checklist

proxy - proxy

Returns:

a TodoHierarchySession

Throws:

NotFoundException - no checklist found by the given Id

NullArgumentException - checklistId or proxy 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(Proxy proxy)
                                                         throws OperationFailedException

Gets the todo hierarchy design session.

Parameters:

proxy - proxy

Returns:

a TodoHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoHierarchyDesign() is false

Compliance:

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

getTodoHierarchyDesignSessionForChecklist

TodoHierarchyDesignSession getTodoHierarchyDesignSessionForChecklist(Id checklistId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the todo hierarchy design session for the given checklist.

Parameters:

checklistId - the Id of the Checklist

proxy - proxy

Returns:

a TodoHierarchyDesignSession

Throws:

NotFoundException - no checklist found by the given Id

NullArgumentException - checklistId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the session for retrieving todo to checklist mappings.

Parameters:

proxy - a proxy

Returns:

a TodoChecklistSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoChecklist() is false

Compliance:

optional - This method must be implemented if supportsTodoChecklist() is 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 - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic todo checklists for the given checklist.

Parameters:

checklistId - the Id of a checklist

proxy - a proxy

Returns:

checklistId not found

Throws:

NotFoundException - checklistId or proxy is null

NullArgumentException - checklistId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the checklist lookup service.

Parameters:

proxy - a proxy

Returns:

a ChecklistLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistLookup() is false

Compliance:

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

getChecklistQuerySession

ChecklistQuerySession getChecklistQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the checklist query service.

Parameters:

proxy - a proxy

Returns:

a ChecklistQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistQueryh() is false

Compliance:

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

getChecklistSearchSession

ChecklistSearchSession getChecklistSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the checklist search service.

Parameters:

proxy - a proxy

Returns:

a ChecklistSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistSearch() is false

Compliance:

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

getChecklistAdminSession

ChecklistAdminSession getChecklistAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the checklist administrative service.

Parameters:

proxy - a proxy

Returns:

a ChecklistAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the checklist notification service.

Parameters:

checklistReceiver - the receiver

proxy - a proxy

Returns:

a ChecklistNotificationSession

Throws:

NullArgumentException - checklistReceiver or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the checklist hierarchy service.

Parameters:

proxy - a proxy

Returns:

a ChecklistHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistHierarchy() is false

Compliance:

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

getChecklistHierarchyDesignSession

ChecklistHierarchyDesignSession getChecklistHierarchyDesignSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the checklist hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a ChecklistHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistHierarchyDesign() is false

Compliance:

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

getChecklistBatchProxyManager

ChecklistBatchProxyManager getChecklistBatchProxyManager()
                                                         throws OperationFailedException

Gets a ChecklistBatchProxyManager.

Returns:

a ChecklistBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistBatch() is false

Compliance:

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

getChecklistMasonProxyManager

ChecklistMasonProxyManager getChecklistMasonProxyManager()
                                                         throws OperationFailedException

Gets a ChecklistMasonProxyManager.

Returns:

a ChecklistMasonProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChecklistMason() is false

Compliance:

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