public interface TodoProducerChecklistAssignmentSession extends OsidSession
This session provides methods to re-assign TodoProducer
to Checklist
mappings. A TodoProducer
may
appear in multiple Checklist
objects and removing the last
reference to a TodoProducer
is the equivalent of deleting
it. Each Checklist
may have its own authorizations
governing who is allowed to operate on it.
Adding a reference of a TodoProducer
to another
Checklist
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignTodoProducerToChecklist(Id todoProducerId,
Id checklistId)
Adds an existing
TodoProducer to an Checklist. |
boolean |
canAssignTodoProducers()
Tests if this user can alter todo producer/checklist mappings.
|
boolean |
canAssignTodoProducersToChecklist(Id checklistId)
Tests if this user can alter todo producer/checklist mappings.
|
IdList |
getAssignableChecklistIds(Id checklistId)
Gets a list of checklists including and under the given checklist node
in which any todo producer can be assigned.
|
IdList |
getAssignableChecklistIdsForTodoProducer(Id checklistId,
Id todoProducerId)
Gets a list of checklists including and under the given checklist node
in which a specific todo producer can be assigned.
|
void |
reassignTodoProducerToChecklist(Id todoProducerId,
Id fromChecklistId,
Id toChecklistId)
Moves a
TodoProducer from one Checklist
to another. |
void |
unassignTodoProducerFromChecklist(Id todoProducerId,
Id checklistId)
Removes a
TodoProducer from an Checklist. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignTodoProducers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignTodoProducersToChecklist(Id checklistId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.checklistId
- the Id
of the Checklist
false
if mapping is not authorized, true
otherwiseNullArgumentException
- checklistId
is
null
mandatory
- This method must be implemented. IdList getAssignableChecklistIds(Id checklistId) throws OperationFailedException
checklistId
- the Id
of the Checklist
Ids
NullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableChecklistIdsForTodoProducer(Id checklistId, Id todoProducerId) throws OperationFailedException
checklistId
- the Id
of the Checklist
todoProducerId
- the Id
of the
TodoProducer
Ids
NullArgumentException
- checklistId
or
todoProducerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignTodoProducerToChecklist(Id todoProducerId, Id checklistId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducer
to an Checklist.
todoProducerId
- the Id
of the
TodoProducer
checklistId
- the Id
of the Checklist
AlreadyExistsException
- todoProducerId
is already assigned to checklistId
NotFoundException
- todoProducerId
or
checklistId
not foundNullArgumentException
- todoProducerId
or checklistId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignTodoProducerFromChecklist(Id todoProducerId, Id checklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducer
from an Checklist.
todoProducerId
- the Id
of the
TodoProducer
checklistId
- the Id
of the Checklist
NotFoundException
- todoProducerId
or
checklistId
not found or todoProducerId
is not assigned to checklistId
NullArgumentException
- todoProducerId
or checklistId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignTodoProducerToChecklist(Id todoProducerId, Id fromChecklistId, Id toChecklistId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducer
from one Checklist
to another. Mappings to other Checklists
are
unaffected.todoProducerId
- the Id
of the
TodoProducer
fromChecklistId
- the Id
of the current
Checklist
toChecklistId
- the Id
of the destination
Checklist
NotFoundException
- todoProducerId,
fromChecklistId,
or toChecklistId
not
found or todoProducerId,
not mapped to
fromChecklistId
NullArgumentException
- todoProducerId,,
fromChecklistId,
or toChecklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.