public interface StepProcessorEnablerAdminSession extends OsidSession
This session creates and removes step processor enablers. The data for
create and update is provided via the StepProcessorEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasStepProcessorEnabler(Id stepProcessorEnablerId,
Id aliasId)
Adds a
Id to a StepProcessorEnabler for
the purpose of creating compatibility. |
boolean |
canCreateStepProcessorEnabler()
Tests if this user can create step processor enablers.
|
boolean |
canCreateStepProcessorEnablerWithRecordTypes(Type[] stepProcessorEnablerRecordTypes)
Tests if this user can create a single
StepProcessorEnabler
using the desired record types. |
boolean |
canDeleteStepProcessorEnablers()
Tests if this user can delete step processor enablers.
|
boolean |
canManageStepProcessorEnablerAliases()
Tests if this user can manage
Id aliases for step
processor enablers. |
boolean |
canUpdateStepProcessorEnablers()
Tests if this user can update step processor enablers.
|
StepProcessorEnabler |
createStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm)
Creates a new
StepProcessorEnabler. |
void |
deleteStepProcessorEnabler(Id stepProcessorEnablerId)
Deletes a
StepProcessorEnabler. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepProcessorEnablerForm |
getStepProcessorEnablerFormForCreate(Type[] stepProcessorEnablerRecordTypes)
Gets the step processor enabler form for creating new step processor
enablers.
|
StepProcessorEnablerForm |
getStepProcessorEnablerFormForUpdate(Id stepProcessorEnablerId)
Gets the step processor enabler form for updating an existing step
processor enabler.
|
void |
updateStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm)
Updates an existing step processor enabler.
|
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 canCreateStepProcessorEnabler()
StepProcessorEnabler
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 StepProcessorEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateStepProcessorEnablerWithRecordTypes(Type[] stepProcessorEnablerRecordTypes)
StepProcessorEnabler
using the desired record types. While
WorkflowRulesManager.getStepProcessorEnablerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
StepProcessorEnabler.
Providing an empty array tests if a
StepProcessorEnabler
can be created with no records.stepProcessorEnablerRecordTypes
- array of step processor
enabler types true
if StepProcessorEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
stepProcessorEnablerRecordTypes
is null
mandatory
- This method must be implemented. StepProcessorEnablerForm getStepProcessorEnablerFormForCreate(Type[] stepProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
stepProcessorEnablerRecordTypes
- array of step processor
enabler typesNullArgumentException
-
stepProcessorEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. StepProcessorEnabler createStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
StepProcessorEnabler.
stepProcessorEnablerForm
- the form for this
StepProcessorEnabler
StepProcessorEnabler
IllegalStateException
- stepProcessorEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- stepProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepProcessorEnablerForm
did not originate from
getStepProcessorEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateStepProcessorEnablers()
StepProcessorEnabler
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 StepProcessorEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. StepProcessorEnablerForm getStepProcessorEnablerFormForUpdate(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
NotFoundException
- stepProcessorEnablerId
is not foundNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
stepProcessorEnablerForm
- the form containing the elements to
be updatedIllegalStateException
- stepProcessorEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- stepProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepProcessorEnablerForm
did not originate from
getStepProcessorEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteStepProcessorEnablers()
StepProcessorEnabler
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 StepProcessorEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteStepProcessorEnabler(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler.
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
to removeNotFoundException
- stepProcessorEnablerId
not foundNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageStepProcessorEnablerAliases()
Id
aliases for step
processor enablers. 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 StepProcessorEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasStepProcessorEnabler(Id stepProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a StepProcessorEnabler
for
the purpose of creating compatibility. The primary Id
of the StepProcessorEnabler
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 enabler. it is reassigned to the given step processor
enabler Id.
stepProcessorEnablerId
- the Id
of a
StepProcessorEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- stepProcessorEnablerId
not foundNullArgumentException
- stepProcessorEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.