public interface JobProcessorEnablerFoundrySession extends OsidSession
This session provides methods to retrieve JobProcessorEnabler
to Foundry
mappings. A JobProcessorEnabler
may appear in multiple Foundry
objects. Each
foundry may have its own authorizations governing who is allowed to look
at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupJobProcessorEnablerFoundryMappings()
Tests if this user can perform lookups of job processor
enabler/foundry mappings.
|
IdList |
getFoundryIdsByJobProcessorEnabler(Id jobProcessorEnablerId)
Gets the
Foundry Ids mapped to a
JobProcessorEnabler. |
FoundryList |
getFoundrysByJobProcessorEnabler(Id jobProcessorEnablerId)
Gets the
Foundries mapped to a
JobProcessorEnabler. |
IdList |
getJobProcessorEnablerIdsByFoundries(IdList foundryIds)
Gets the list of
JobProcessorEnabler Ids corresponding
to a list of Foundries. |
IdList |
getJobProcessorEnablerIdsByFoundry(Id foundryId)
Gets the list of
JobProcessorEnablerIds associated with
a Foundry. |
JobProcessorEnablerList |
getJobProcessorEnablersByFoundries(IdList foundryIds)
Gets the list of job processor enablers corresponding to a list of
Foundries. |
JobProcessorEnablerList |
getJobProcessorEnablersByFoundry(Id foundryId)
Gets the list of job processor enablers associated with a
Foundry. |
void |
useComparativeJobProcessorEnablerFoundryView()
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 |
usePlenaryJobProcessorEnablerFoundryView()
A complete view of the
JobProcessorEnabler and
Foundry returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupJobProcessorEnablerFoundryMappings()
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 useComparativeJobProcessorEnablerFoundryView()
mandatory
- This method is must be implemented. void usePlenaryJobProcessorEnablerFoundryView()
JobProcessorEnabler
and
Foundry
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. IdList getJobProcessorEnablerIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnablerIds
associated with
a Foundry.
foundryId
- Id
of the Foundry
Ids
NotFoundException
- foundryId
is not
foundNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry.
foundryId
- Id
of the Foundry
NotFoundException
- foundryId
is not
foundNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getJobProcessorEnablerIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
JobProcessorEnabler Ids
corresponding
to a list of Foundries.
foundryIds
- list of foundry Ids
Ids
NullArgumentException
- foundryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Foundries.
foundryIds
- list of foundry Ids
NullArgumentException
- foundryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFoundryIdsByJobProcessorEnabler(Id jobProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
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. FoundryList getFoundrysByJobProcessorEnabler(Id jobProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
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.