public interface ProcessEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve ProcessEnabler
to Process
mappings. A Process
with multiple
ProcessEnablers
means any positive rule evaluation across
the constrainers result in an accessible Process.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProcessEnablerRules()
Tests if this user can perform lookups of process enabler/process
mappings.
|
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
IdList |
getProcessEnablerIdsForProcess(Id processId)
Gets the
ProcessEnabler Id associated with a
Process. |
ProcessEnablerList |
getProcessEnablersForProcess(Id processId)
Gets the
ProcessEnabler associated with a
Process. |
IdList |
getProcessIdsForProcessEnabler(Id processEnablerId)
Gets the
Process Ids mapped to a
ProcessEnabler. |
ProcessList |
getProcesssForProcessEnabler(Id processEnablerId)
Gets the
Processs mapped to a ProcessEnabler. |
void |
useComparativeProcessEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedOfficeView()
Isolates the view for methods in this session.
|
void |
usePlenaryProcessEnablerRuleView()
A complete view of the
ProcessEnabler and
Process returns is desired. |
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 canLookupProcessEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProcessEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryProcessEnablerRuleView()
ProcessEnabler
and
Process
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. IdList getProcessEnablerIdsForProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProcessEnabler Id
associated with a
Process.
processId
- Id
of the Process
Ids
NotFoundException
- processId
is not
foundNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersForProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProcessEnabler
associated with a
Process.
processId
- Id
of the Process
NotFoundException
- processId
is not
foundNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProcessIdsForProcessEnabler(Id processEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Process
Ids
mapped to a
ProcessEnabler.
processEnablerId
- Id
of a ProcessEnabler
Ids
NotFoundException
- processEnablerId
is
not foundNullArgumentException
- processEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessList getProcesssForProcessEnabler(Id processEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Processs
mapped to a ProcessEnabler.
processEnablerId
- Id
of a ProcessEnabler
NotFoundException
- processEnablerId
is
not foundNullArgumentException
- processEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.