public interface StepConstrainerAdminSession extends OsidSession
This session creates and removes step constrainers. The data for create
and update is provided via the StepConstrainerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasStepConstrainer(Id stepConstrainerId,
Id aliasId)
Adds a
Id to a StepConstrainer for the
purpose of creating compatibility. |
boolean |
canCreateStepConstrainer()
Tests if this user can create step constrainers.
|
boolean |
canCreateStepConstrainerWithRecordTypes(Type[] stepConstrainerRecordTypes)
Tests if this user can create a single
StepConstrainer
using the desired record types. |
boolean |
canDeleteStepConstrainers()
Tests if this user can delete step constrainers.
|
boolean |
canManageStepConstrainerAliases()
Tests if this user can manage
Id aliases for step
constrainers. |
boolean |
canUpdateStepConstrainers()
Tests if this user can update step constrainers.
|
StepConstrainer |
createStepConstrainer(StepConstrainerForm stepConstrainerForm)
Creates a new
StepConstrainer. |
void |
deleteStepConstrainer(Id stepConstrainerId)
Deletes a
StepConstrainer. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepConstrainerForm |
getStepConstrainerFormForCreate(Type[] stepConstrainerRecordTypes)
Gets the step constrainer form for creating new step constrainers.
|
StepConstrainerForm |
getStepConstrainerFormForUpdate(Id stepConstrainerId)
Gets the step constrainer form for updating an existing step
constrainer.
|
void |
updateStepConstrainer(StepConstrainerForm stepConstrainerForm)
Updates an existing step constrainer.
|
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 canCreateStepConstrainer()
StepConstrainer
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 StepConstrainer
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateStepConstrainerWithRecordTypes(Type[] stepConstrainerRecordTypes)
StepConstrainer
using the desired record types. While
WorkflowRulesManager.getStepConstrainerRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific StepConstrainer.
Providing an empty array tests if a StepConstrainer
can be created with no records.stepConstrainerRecordTypes
- array of step constrainer record
types true
if StepConstrainer
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
stepConstrainerRecordTypes
is null
mandatory
- This method must be implemented. StepConstrainerForm getStepConstrainerFormForCreate(Type[] stepConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
stepConstrainerRecordTypes
- array of step constrainer record
typesNullArgumentException
-
stepConstrainerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. StepConstrainer createStepConstrainer(StepConstrainerForm stepConstrainerForm) throws OperationFailedException, PermissionDeniedException
StepConstrainer.
stepConstrainerForm
- the form for this StepConstrainer
StepConstrainer
IllegalStateException
- stepConstrainerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- stepConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepConstrainerForm
did not originate from
getStepConstrainerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateStepConstrainers()
StepConstrainer
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 StepConstrainer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. StepConstrainerForm getStepConstrainerFormForUpdate(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerId
- the Id
of the
StepConstrainer
NotFoundException
- stepConstrainerId
is
not foundNullArgumentException
- stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateStepConstrainer(StepConstrainerForm stepConstrainerForm) throws OperationFailedException, PermissionDeniedException
stepConstrainerForm
- the form containing the elements to be
updatedIllegalStateException
- stepConstrainerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- stepConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepConstrainerForm
did not originate from
getStepConstrainerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteStepConstrainers()
StepConstrainer
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 StepConstrainer
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteStepConstrainer(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainer.
stepConstrainerId
- the Id
of the
StepConstrainer
to removeNotFoundException
- stepConstrainerId
not foundNullArgumentException
- stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageStepConstrainerAliases()
Id
aliases for step
constrainers. 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 StepConstrainer
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasStepConstrainer(Id stepConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a StepConstrainer
for the
purpose of creating compatibility. The primary Id
of
the StepConstrainer
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 constrainer. it is
reassigned to the given step constrainer Id.
stepConstrainerId
- the Id
of a
StepConstrainer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- stepConstrainerId
not foundNullArgumentException
- stepConstrainerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.