Interface ChecklistMasonManager

All Superinterfaces:

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

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

getTodoProducerRecordTypes, getTodoProducerSearchRecordTypes, supportsTodoProducerAdmin, supportsTodoProducerChecklist, supportsTodoProducerChecklistAssignment, supportsTodoProducerLookup, supportsTodoProducerNotification, supportsTodoProducerQuery, supportsTodoProducerRecordType, supportsTodoProducerSearch, supportsTodoProducerSearchRecordType, supportsTodoProducerSmartChecklist, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getTodoProducerRecordTypes()	Gets the supported TodoProducer record types.
TypeList	getTodoProducerSearchRecordTypes()	Gets the supported TodoProducer search record types.
boolean	supportsTodoProducerAdmin()	Tests if a todo producer administrative service is supported.
boolean	supportsTodoProducerChecklist()	Tests if a todo producer checklist lookup service is supported.
boolean	supportsTodoProducerChecklistAssignment()	Tests if a todo producer checklist service is supported.
boolean	supportsTodoProducerLookup()	Tests if looking up todo producers is supported.
boolean	supportsTodoProducerNotification()	Tests if a todo producer notification service is supported.
boolean	supportsTodoProducerQuery()	Tests if querying todo producers is supported.
boolean	supportsTodoProducerRecordType(Type todoProducerRecordType)	Tests if the given TodoProducer record type is supported.
boolean	supportsTodoProducerSearch()	Tests if searching todo producers is supported.
boolean	supportsTodoProducerSearchRecordType(Type todoProducerSearchRecordType)	Tests if the given TodoProducer search record type is supported.
boolean	supportsTodoProducerSmartChecklist()	Tests if a todo producer checklist lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker 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

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 {@code supportsTodoProducerLookup()} is {@code 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 {@code supportsTodoProducerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoProducerQuery()} is {@code 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 {@code supportsTodoProducerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoProducerSearch()} is {@code 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 {@code supportsTodoProducerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoProducerAdmin()} is {@code 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 {@code supportsTodoProducerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoProducerNotification()} is {@code 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 {@code supportsTodoProducerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTodoProducerChecklist()} is {@code 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 {@code supportsTodoProducerChecklistAssignment()} is {@code 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 {@code supportsTodoProducerSmartChecklist()} is {@code true} .