public interface TodoProducerAdminSession extends OsidSession
This session creates and removes todo producers. The data for create
and update is provided via the TodoProducerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasTodoProducer(Id todoProducerId,
Id aliasId)
Adds an
Id to a TodoProducer for the
purpose of creating compatibility. |
boolean |
canCreateTodoProducer()
Tests if this user can create todo producers.
|
boolean |
canCreateTodoProducerWithRecordTypes(Type[] todoProducerRecordTypes)
Tests if this user can create a single
TodoProducer
using the desired record types. |
boolean |
canDeleteTodoProducers()
Tests if this user can delete todo producers.
|
boolean |
canManageTodoProducerAliases()
Tests if this user can manage
Id aliases for todo
producers. |
boolean |
canUpdateTodoProducers()
Tests if this user can update todo producers.
|
TodoProducer |
createTodoProducer(TodoProducerForm todoProducerForm)
Creates a new
TodoProducer. |
void |
deleteTodoProducer(Id todoProducerId)
Deletes a
TodoProducer. |
Checklist |
getChecklist()
Gets the
Checklist associated with this session. |
Id |
getChecklistId()
Gets the
Checklist Id associated with
this session. |
TodoProducerForm |
getTodoProducerFormForCreate(Type[] todoProducerRecordTypes)
Gets the todo producer form for creating new todo producers.
|
TodoProducerForm |
getTodoProducerFormForUpdate(Id todoProducerId)
Gets the todo producer form for updating an existing todo producer.
|
void |
updateTodoProducer(TodoProducerForm todoProducerForm)
Updates an existing todo producer.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getChecklistId()
Checklist
Id
associated with
this session. Checklist Id
associated with this sessionmandatory
- This method must be implemented. Checklist getChecklist() throws OperationFailedException, PermissionDeniedException
Checklist
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateTodoProducer()
TodoProducer
will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer create operations to an
unauthorized user. false
if TodoProducer
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateTodoProducerWithRecordTypes(Type[] todoProducerRecordTypes)
TodoProducer
using the desired record types. While
ChecklistMasonManager.getTodoProducerRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific TodoProducer.
Providing an empty array tests if a TodoProducer
can be created with no records.todoProducerRecordTypes
- array of todo producer record types true
if TodoProducer
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- todoProducerRecordTypes
is null
mandatory
- This method must be implemented. TodoProducerForm getTodoProducerFormForCreate(Type[] todoProducerRecordTypes) throws OperationFailedException, PermissionDeniedException
todoProducerRecordTypes
- array of todo producer record typesNullArgumentException
- todoProducerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. TodoProducer createTodoProducer(TodoProducerForm todoProducerForm) throws OperationFailedException, PermissionDeniedException
TodoProducer.
todoProducerForm
- the form for this TodoProducer
TodoProducer
IllegalStateException
- todoProducerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- todoProducerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- todoProducerForm
did not originate from getTodoProducerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateTodoProducers()
TodoProducer
will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer update operations to an
unauthorized user. false
if TodoProducer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. TodoProducerForm getTodoProducerFormForUpdate(Id todoProducerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
todoProducerId
- the Id
of the
TodoProducer
NotFoundException
- todoProducerId
is
not foundNullArgumentException
- todoProducerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateTodoProducer(TodoProducerForm todoProducerForm) throws OperationFailedException, PermissionDeniedException
todoProducerForm
- the form containing the elements to be
updatedIllegalStateException
- todoProducerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- todoProducerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- todoProducerForm
did not originate from getTodoProducerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteTodoProducers()
TodoProducer
will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer delete operations to an
unauthorized user. false
if TodoProducer
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteTodoProducer(Id todoProducerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TodoProducer.
todoProducerId
- the Id
of the
TodoProducer
to removeNotFoundException
- todoProducerId
not
foundNullArgumentException
- todoProducerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageTodoProducerAliases()
Id
aliases for todo
producers. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if TodoProducer
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasTodoProducer(Id todoProducerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a TodoProducer
for the
purpose of creating compatibility. The primary Id
of
the TodoProducer
is determined by the provider. The new
Id
performs as an alias to the primary Id
. If the alias is a pointer to another todo producer. it is
reassigned to the given todo producer Id.
todoProducerId
- the Id
of a TodoProducer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- todoProducerId
not
foundNullArgumentException
- todoProducerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.