public interface StepProcessorAdminSession extends OsidSession
This session creates and removes step processors. The data for create
and update is provided via the StepProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasStepProcessor(Id stepProcessorId,
Id aliasId)
Adds a
Id to a StepProcessor for the
purpose of creating compatibility. |
boolean |
canCreateStepProcessor()
Tests if this user can create step processors.
|
boolean |
canCreateStepProcessorWithRecordTypes(Type[] stepProcessorRecordTypes)
Tests if this user can create a single
StepProcessor
using the desired record types. |
boolean |
canDeleteStepProcessors()
Tests if this user can delete step processors.
|
boolean |
canManageStepProcessorAliases()
Tests if this user can manage
Id aliases for step
processors. |
boolean |
canUpdateStepProcessors()
Tests if this user can update step processors.
|
StepProcessor |
createStepProcessor(StepProcessorForm stepProcessorForm)
Creates a new
StepProcessor. |
void |
deleteStepProcessor(Id stepProcessorId)
Deletes a
StepProcessor. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepProcessorForm |
getStepProcessorFormForCreate(Type[] stepProcessorRecordTypes)
Gets the step processor form for creating new step processors.
|
StepProcessorForm |
getStepProcessorFormForUpdate(Id stepProcessorId)
Gets the step processor form for updating an existing step processor.
|
void |
updateStepProcessor(StepProcessorForm stepProcessorForm)
Updates an existing step processor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateStepProcessor()
StepProcessor
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 StepProcessor
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateStepProcessorWithRecordTypes(Type[] stepProcessorRecordTypes)
StepProcessor
using the desired record types. While
WorkflowRulesManager.getStepProcessorRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific StepProcessor.
Providing an empty array tests if a StepProcessor
can be created with no records.stepProcessorRecordTypes
- array of step processor record types true
if StepProcessor
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- stepProcessorRecordTypes
is null
mandatory
- This method must be implemented. StepProcessorForm getStepProcessorFormForCreate(Type[] stepProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
stepProcessorRecordTypes
- array of step processor record typesNullArgumentException
- stepProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. StepProcessor createStepProcessor(StepProcessorForm stepProcessorForm) throws OperationFailedException, PermissionDeniedException
StepProcessor.
stepProcessorForm
- the form for this StepProcessor
StepProcessor
IllegalStateException
- stepProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- stepProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepProcessorForm did not
originate from getStepProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateStepProcessors()
StepProcessor
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 StepProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. StepProcessorForm getStepProcessorFormForUpdate(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepProcessorId
- the Id
of the
StepProcessor
NotFoundException
- stepProcessorId
is
not foundNullArgumentException
- stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateStepProcessor(StepProcessorForm stepProcessorForm) throws OperationFailedException, PermissionDeniedException
stepProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- stepProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- stepProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepProcessorForm did not
originate from getStepProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteStepProcessors()
StepProcessor
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 StepProcessor
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessor.
stepProcessorId
- the Id
of the
StepProcessor
to removeNotFoundException
- stepProcessorId
not
foundNullArgumentException
- stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageStepProcessorAliases()
Id
aliases for step
processors. 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 StepProcessor
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasStepProcessor(Id stepProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a StepProcessor
for the
purpose of creating compatibility. The primary Id
of
the StepProcessor
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another step processor. it is
reassigned to the given step processor Id.
stepProcessorId
- the Id
of a
StepProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- stepProcessorId
not
foundNullArgumentException
- stepProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.