public interface ProcessEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply ProcessEnablers
to Processs.
A Process
with multiple
ProcessEnablers
means any positive rule evaluation across the
constrainers result in an accessible Process.
Modifier and Type | Method and Description |
---|---|
void |
assignProcessEnablerToProcess(Id processEnablerId,
Id processId)
Adds an existing
ProcessEnabler to a Process. |
boolean |
canAssignProcessEnablers()
Tests if this user can alter process enabler/process mappings.
|
boolean |
canSequenceProcessEnablers()
Tests if this user can order
ProcessEnablers. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
moveProcessEnablerAhead(Id processEnablerId,
Id processId,
Id referenceId)
Reorders process enablers for a process by moving the specified
process enabler in front of a reference process enabler.
|
void |
moveProcessEnablerBehind(Id processEnablerId,
Id processId,
Id referenceId)
Reorders process enablers for a process by moving the specified
process enabler behind a reference process enabler.
|
void |
orderProcessEnablers(Id[] processEnablerIds,
Id processId)
Reorders a set of process enablers for a process.
|
void |
unassignProcessEnablerFromProcess(Id processEnablerId,
Id processId)
Removes a
ProcessEnabler from a Process. |
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 canAssignProcessEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignProcessEnablerToProcess(Id processEnablerId, Id processId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ProcessEnabler
to a Process.
processEnablerId
- the Id
of the
ProcessEnabler
processId
- the Id
of the Process
AlreadyExistsException
- processEnablerId
is already applied to processId
NotFoundException
- processEnablerId
or
processId
not foundNullArgumentException
- processEnablerId
or processId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignProcessEnablerFromProcess(Id processEnablerId, Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProcessEnabler
from a Process.
processEnablerId
- the Id
of the
ProcessEnabler
processId
- the Id
of the Process
NotFoundException
- processEnablerId
or
processId
not found or processEnablerId
not applied to processId
NullArgumentException
- processEnablerId
or processId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceProcessEnablers()
ProcessEnablers.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if ProcessEnabler
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveProcessEnablerAhead(Id processEnablerId, Id processId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processEnablerId
- the Id
of a
ProcessEnabler
processId
- the Id
of a Process
referenceId
- the reference process enabler Id
NotFoundException
- processEnablerId, processId,
or referenceId
not found or,
processEnablerId
or referenceId
not
related to processId
NullArgumentException
- processEnablerId,
processId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveProcessEnablerBehind(Id processEnablerId, Id processId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processEnablerId
- the Id
of a
ProcessEnabler
processId
- the Id
of a Process
referenceId
- the reference process enabler Id
NotFoundException
- processEnablerId, processId,
or referenceId
not found or,
processEnablerId
or referenceId
not
related to processId
NullArgumentException
- processEnablerId,
processId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderProcessEnablers(Id[] processEnablerIds, Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processEnablerIds
- the Ids
for a set of
ProcessEnablers
processId
- the Id
of a Process
NotFoundException
- processId
not found
or, an processEnablerId
not related to
processId
NullArgumentException
- processEnabelrIds
or processId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.