public interface JobProcessorEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve JobProcessorEnabler
to JobProcessor
mappings. A JobProcessor
with multiple JobProcessorEnablers
means any
positive rule evaluation across the enablers result in an effective
JobProcessor.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupJobProcessorEnablerRules()
Tests if this user can perform lookups of job processor enabler/job
processor mappings.
|
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
IdList |
getJobProcessorEnablerIdsForJobProcessor(Id jobProcessorId)
Gets the
JobProcessorEnabler Id associated with a
JobProcessor. |
JobProcessorEnablerList |
getJobProcessorEnablersForJobProcessor(Id jobProcessorId)
Gets the
JobProcessorEnabler associated with a
JobProcessor. |
IdList |
getJobProcessorIdsForJobProcessorEnabler(Id jobProcessorEnablerId)
Gets the
JobProcessor Ids mapped to a
JobProcessorEnabler. |
JobProcessorList |
getJobProcessorsForJobProcessorEnabler(Id jobProcessorEnablerId)
Gets the
JobProcessors mapped to a
JobProcessorEnabler. |
void |
useComparativeJobProcessorEnablerRuleView()
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 |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
void |
usePlenaryJobProcessorEnablerRuleView()
A complete view of the
JobProcessorEnabler and
JobProcessor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupJobProcessorEnablerRules()
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 useComparativeJobProcessorEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryJobProcessorEnablerRuleView()
JobProcessorEnabler
and
JobProcessor
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. IdList getJobProcessorEnablerIdsForJobProcessor(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnabler Id
associated with a
JobProcessor.
jobProcessorId
- Id
of the JobProcessor
Ids
NotFoundException
- jobProcessorId
is
not foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersForJobProcessor(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnabler
associated with a
JobProcessor.
jobProcessorId
- Id
of the JobProcessor
NotFoundException
- jobProcessorId
is
not foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getJobProcessorIdsForJobProcessorEnabler(Id jobProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessor
Ids
mapped to a
JobProcessorEnabler.
jobProcessorEnablerId
- Id
of a
JobProcessorEnabler
Ids
NotFoundException
- jobProcessorEnablerId
is not foundNullArgumentException
- jobProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorList getJobProcessorsForJobProcessorEnabler(Id jobProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessors
mapped to a
JobProcessorEnabler.
jobProcessorEnablerId
- Id
of a
JobProcessorEnabler
NotFoundException
- jobProcessorEnablerId
is not foundNullArgumentException
- jobProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.