org.osid.checklist.mason

Interface ChecklistMasonManager

All Superinterfaces:

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

public interface ChecklistMasonManager
extends OsidManager, ChecklistMasonProfile

The checklist mason manager provides access to checklist mason sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the todo producer administration service.
TodoProducerAdminSession	getTodoProducerAdminSessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo producer administration service for the given checklist.
TodoProducerChecklistAssignmentSession	getTodoProducerChecklistAssignmentSession() Gets the OsidSession associated with assigning todo producers to checklists for todo.
TodoProducerChecklistSession	getTodoProducerChecklistSession() Gets the OsidSession to lookup todo producer/checklist mappings for todo producers.
TodoProducerLookupSession	getTodoProducerLookupSession() Gets the OsidSession associated with the todo producer lookup service.
TodoProducerLookupSession	getTodoProducerLookupSessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo producer lookup service for the given checklist.
TodoProducerNotificationSession	getTodoProducerNotificationSession(TodoProducerReceiver todoProducerReceiver) Gets the OsidSession associated with the todo producer notification service.
TodoProducerNotificationSession	getTodoProducerNotificationSessionForChecklist(TodoProducerReceiver todoProducerReceiver, Id checklistId) Gets the OsidSession associated with the todo producer notification service for the given checklist.
TodoProducerQuerySession	getTodoProducerQuerySession() Gets the OsidSession associated with the todo producer query service.
TodoProducerQuerySession	getTodoProducerQuerySessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo producer query service for the given checklist.
TodoProducerSearchSession	getTodoProducerSearchSession() Gets the OsidSession associated with the todo producer search service.
TodoProducerSearchSession	getTodoProducerSearchSessionForChecklist(Id checklistId) Gets the OsidSession associated with the todo producers earch service for the given checklist.
TodoProducerSmartChecklistSession	getTodoProducerSmartChecklistSession(Id checklistId) Gets the OsidSession to manage todo producer smart checklists.

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

Gets the OsidSession associated with the todo producer lookup service.

Returns:

a TodoProducerLookupSession

Throws:

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

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

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoProducerLookupSession

Throws:

NotFoundException - no Checklist found by the given Id

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

Gets the OsidSession associated with the todo producer query service.

Returns:

a TodoProducerQuerySession

Throws:

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

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

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoProducerQuerySession

Throws:

NotFoundException - no Checklist found by the given Id

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

Gets the OsidSession associated with the todo producer search service.

Returns:

a TodoProducerSearchSession

Throws:

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

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

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoProducerSearchSession

Throws:

NotFoundException - no Checklist found by the given Id

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

Gets the OsidSession associated with the todo producer administration service.

Returns:

a TodoProducerAdminSession

Throws:

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

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

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoProducerAdminSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId 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)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the todo producer notification service.

Parameters:

todoProducerReceiver - the notification callback

Returns:

a TodoProducerNotificationSession

Throws:

NullArgumentException - todoProducerReceiver 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)
                                                                               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

Returns:

a TodoProducerNotificationSession

Throws:

NotFoundException - no checklist found by the given Id

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

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

Returns:

a TodoProducerChecklistSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerChecklist() is false

Compliance:

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

getTodoProducerChecklistAssignmentSession

TodoProducerChecklistAssignmentSession getTodoProducerChecklistAssignmentSession()
                                                                                 throws OperationFailedException

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

Returns:

a TodoProducerChecklistAssignmentSession

Throws:

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

Gets the OsidSession to manage todo producer smart checklists.

Parameters:

checklistId - the Id of the Checklist

Returns:

a TodoProducerSmartChecklistSession

Throws:

NotFoundException - no Checklist found by the given Id

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTodoProducerSmartChecklist() is false

Compliance:

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