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 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. |
changeBranch, initialize, rollbackService
close
getTodoProducerRecordTypes, getTodoProducerSearchRecordTypes, supportsTodoProducerAdmin, supportsTodoProducerChecklist, supportsTodoProducerChecklistAssignment, supportsTodoProducerLookup, supportsTodoProducerNotification, supportsTodoProducerQuery, supportsTodoProducerRecordType, supportsTodoProducerSearch, supportsTodoProducerSearchRecordType, supportsTodoProducerSmartChecklist, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
TodoProducerLookupSession getTodoProducerLookupSession() throws OperationFailedException
OsidSession
associated with the todo producer
lookup service. TodoProducerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerLookup()
is false
optional
- This method must be implemented if
supportsTodoProducerLookup()
is true.
TodoProducerLookupSession getTodoProducerLookupSessionForChecklist(Id checklistId) throws NotFoundException, OperationFailedException
OsidSession
associated with the todo producer
lookup service for the given checklist.checklistId
- the Id
of the Checklist
TodoProducerLookupSession
NotFoundException
- no Checklist
found
by the given Id
NullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTodoProducerLookup()
and
supportsVisibleFederation()
are true.
TodoProducerQuerySession getTodoProducerQuerySession() throws OperationFailedException
OsidSession
associated with the todo producer
query service. TodoProducerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerQuery()
is false
optional
- This method must be implemented if
supportsTodoProducerQuery()
is true.
TodoProducerQuerySession getTodoProducerQuerySessionForChecklist(Id checklistId) throws NotFoundException, OperationFailedException
OsidSession
associated with the todo producer
query service for the given checklist.checklistId
- the Id
of the Checklist
TodoProducerQuerySession
NotFoundException
- no Checklist
found
by the given Id
NullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTodoProducerQuery()
and
supportsVisibleFederation()
are true.
TodoProducerSearchSession getTodoProducerSearchSession() throws OperationFailedException
OsidSession
associated with the todo producer
search service. TodoProducerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerSearch()
is false
optional
- This method must be implemented if
supportsTodoProducerSearch()
is true.
TodoProducerSearchSession getTodoProducerSearchSessionForChecklist(Id checklistId) throws NotFoundException, OperationFailedException
OsidSession
associated with the todo producers
earch service for the given checklist.checklistId
- the Id
of the Checklist
TodoProducerSearchSession
NotFoundException
- no Checklist
found
by the given Id
NullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTodoProducerSearch()
and
supportsVisibleFederation()
are true.
TodoProducerAdminSession getTodoProducerAdminSession() throws OperationFailedException
OsidSession
associated with the todo producer
administration service. TodoProducerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerAdmin()
is false
optional
- This method must be implemented if
supportsTodoProducerAdmin()
is true.
TodoProducerAdminSession getTodoProducerAdminSessionForChecklist(Id checklistId) throws NotFoundException, OperationFailedException
OsidSession
associated with the todo producer
administration service for the given checklist.checklistId
- the Id
of the Checklist
TodoProducerAdminSession
NotFoundException
- no Checklist
found
by the given Id
NullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTodoProducerAdmin()
and
supportsVisibleFederation()
are true.
TodoProducerNotificationSession getTodoProducerNotificationSession(TodoProducerReceiver todoProducerReceiver) throws OperationFailedException
OsidSession
associated with the todo producer
notification service.todoProducerReceiver
- the notification callback TodoProducerNotificationSession
NullArgumentException
- todoProducerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerNotification()
is false
optional
- This method must be implemented if
supportsTodoProducerNotification()
is true.
TodoProducerNotificationSession getTodoProducerNotificationSessionForChecklist(TodoProducerReceiver todoProducerReceiver, Id checklistId) throws NotFoundException, OperationFailedException
OsidSession
associated with the todo producer
notification service for the given checklist.todoProducerReceiver
- the notification callbackchecklistId
- the Id
of the Checklist
TodoProducerNotificationSession
NotFoundException
- no checklist found by the given
Id
NullArgumentException
- todoProducerReceiver
or checklistId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTodoProducerNotification()
and
supportsVisibleFederation()
are true.
TodoProducerChecklistSession getTodoProducerChecklistSession() throws OperationFailedException
OsidSession
to lookup todo producer/checklist
mappings for todo producers. TodoProducerChecklistSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerChecklist()
is false
optional
- This method must be implemented if
supportsTodoProducerChecklist()
is true.
TodoProducerChecklistAssignmentSession getTodoProducerChecklistAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning todo
producers to checklists for todo. TodoProducerChecklistAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerChecklistAssignment()
is
false
optional
- This method must be implemented if
supportsTodoProducerChecklistAssignment()
is
true.
TodoProducerSmartChecklistSession getTodoProducerSmartChecklistSession(Id checklistId) throws NotFoundException, OperationFailedException
OsidSession
to manage todo producer smart
checklists.checklistId
- the Id
of the Checklist
TodoProducerSmartChecklistSession
NotFoundException
- no Checklist
found
by the given Id
NullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTodoProducerSmartChecklist()
is false
optional
- This method must be implemented if
supportsTodoProducerSmartChecklist()
is
true.