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