org.osid.checklist.mason

Interface ChecklistMasonProxyManager

All Superinterfaces:

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

public interface ChecklistMasonProxyManager
extends OsidProxyManager, ChecklistMasonProfile

The checklist mason proxy manager provides access to checklist mason sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• TodoProducerLookupSession: a session to retrieve todo producers
• TodoProducerQuerySession: a session to query for todo producers
• TodoProducerSearchSession: a session to search for todo producers
• TodoProducerAdminSession: a session to create and delete todo producers
• TodoProducerNotificationSession: a session to receive notifications pertaining to todo producer changes
• TodoProducerChecklistSession: a session to look up todo producer checklist mappings
• TodoProducerChecklistAssignmentSession: a session to manage todo producer to checklist mappings
• TodoProducerSmartChecklistSession: a session to manage dynamic checklists of todo producers

Method Summary

Methods

Modifier and Type	Method and Description
TodoProducerAdminSession	getTodoProducerAdminSession(Proxy proxy) Gets the OsidSession associated with the todo producer administration service.
TodoProducerAdminSession	getTodoProducerAdminSessionForChecklist(Id checklistId, Proxy proxy) Gets the OsidSession associated with the todo producer administration service for the given checklist.
TodoProducerChecklistAssignmentSession	getTodoProducerChecklistAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning todo producers to checklists for todo.
TodoProducerChecklistSession	getTodoProducerChecklistSession(Proxy proxy) Gets the OsidSession to lookup todo producer/checklist mappings for todo producers.
TodoProducerLookupSession	getTodoProducerLookupSession(Proxy proxy) Gets the OsidSession associated with the todo producer lookup service.
TodoProducerLookupSession	getTodoProducerLookupSessionForChecklist(Id checklistId, Proxy proxy) Gets the OsidSession associated with the todo producer lookup service for the given checklist.
TodoProducerNotificationSession	getTodoProducerNotificationSession(TodoProducerReceiver todoProducerReceiver, Proxy proxy) Gets the OsidSession associated with the todo producer notification service.
TodoProducerNotificationSession	getTodoProducerNotificationSessionForChecklist(TodoProducerReceiver todoProducerReceiver, Id checklistId, Proxy proxy) Gets the OsidSession associated with the todo producer notification service for the given checklist.
TodoProducerQuerySession	getTodoProducerQuerySession(Proxy proxy) Gets the OsidSession associated with the todo producer query service.
TodoProducerQuerySession	getTodoProducerQuerySessionForChecklist(Id checklistId, Proxy proxy) Gets the OsidSession associated with the todo producer query service for the given checklist.
TodoProducerSearchSession	getTodoProducerSearchSession(Proxy proxy) Gets the OsidSession associated with the todo producer search service.
TodoProducerSearchSession	getTodoProducerSearchSessionForChecklist(Id checklistId, Proxy proxy) Gets the OsidSession associated with the todo producers earch service for the given checklist.
TodoProducerSmartChecklistSession	getTodoProducerSmartChecklistSession(Id checklistId, Proxy proxy) Gets the OsidSession to manage todo producer smart checklists.

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.mason.ChecklistMasonProfile

getTodoProducerRecordTypes, getTodoProducerSearchRecordTypes, supportsTodoProducerAdmin, supportsTodoProducerChecklist, supportsTodoProducerChecklistAssignment, supportsTodoProducerLookup, supportsTodoProducerNotification, supportsTodoProducerQuery, supportsTodoProducerRecordType, supportsTodoProducerSearch, supportsTodoProducerSearchRecordType, supportsTodoProducerSmartChecklist, 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

getTodoProducerLookupSession

TodoProducerLookupSession getTodoProducerLookupSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the todo producer lookup service.

Parameters:

proxy - a proxy

Returns:

a TodoProducerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerLookup() is false

Compliance:

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

getTodoProducerLookupSessionForChecklist

TodoProducerLookupSession getTodoProducerLookupSessionForChecklist(Id checklistId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoProducerLookupSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerLookup() or supportsVisibleFederation() is false

Compliance:

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

getTodoProducerQuerySession

TodoProducerQuerySession getTodoProducerQuerySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the todo producer query service.

Parameters:

proxy - a proxy

Returns:

a TodoProducerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerQuery() is false

Compliance:

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

getTodoProducerQuerySessionForChecklist

TodoProducerQuerySession getTodoProducerQuerySessionForChecklist(Id checklistId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoProducerQuerySession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerQuery() or supportsVisibleFederation() is false

Compliance:

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

getTodoProducerSearchSession

TodoProducerSearchSession getTodoProducerSearchSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the todo producer search service.

Parameters:

proxy - a proxy

Returns:

a TodoProducerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerSearch() is false

Compliance:

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

getTodoProducerSearchSessionForChecklist

TodoProducerSearchSession getTodoProducerSearchSessionForChecklist(Id checklistId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the todo producers earch service for the given checklist.

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoProducerSearchSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerSearch() or supportsVisibleFederation() is false

Compliance:

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

getTodoProducerAdminSession

TodoProducerAdminSession getTodoProducerAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the todo producer administration service.

Parameters:

proxy - a proxy

Returns:

a TodoProducerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerAdmin() is false

Compliance:

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

getTodoProducerAdminSessionForChecklist

TodoProducerAdminSession getTodoProducerAdminSessionForChecklist(Id checklistId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoProducerAdminSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getTodoProducerNotificationSession

TodoProducerNotificationSession getTodoProducerNotificationSession(TodoProducerReceiver todoProducerReceiver,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the todo producer notification service.

Parameters:

todoProducerReceiver - the notification callback

proxy - a proxy

Returns:

a TodoProducerNotificationSession

Throws:

NullArgumentException - todoProducerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerNotification() is false

Compliance:

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

getTodoProducerNotificationSessionForChecklist

TodoProducerNotificationSession getTodoProducerNotificationSessionForChecklist(TodoProducerReceiver todoProducerReceiver,
                                                                             Id checklistId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

todoProducerReceiver - the notification callback

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoProducerNotificationSession

Throws:

NotFoundException - no checklist found by the given Id

NullArgumentException - todoProducerReceiver, checklistId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerNotification() or supportsVisibleFederation() is false

Compliance:

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

getTodoProducerChecklistSession

TodoProducerChecklistSession getTodoProducerChecklistSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession to lookup todo producer/checklist mappings for todo producers.

Parameters:

proxy - a proxy

Returns:

a TodoProducerChecklistSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerChecklist() is false

Compliance:

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

getTodoProducerChecklistAssignmentSession

TodoProducerChecklistAssignmentSession getTodoProducerChecklistAssignmentSession(Proxy proxy)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning todo producers to checklists for todo.

Parameters:

proxy - a proxy

Returns:

a TodoProducerChecklistAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerChecklistAssignment() is false

Compliance:

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

getTodoProducerSmartChecklistSession

TodoProducerSmartChecklistSession getTodoProducerSmartChecklistSession(Id checklistId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession to manage todo producer smart checklists.

Parameters:

checklistId - the Id of the Checklist

proxy - a proxy

Returns:

a TodoProducerSmartChecklistSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerSmartChecklist() is false

Compliance:

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