public interface JobProcessorFoundrySession extends OsidSession
This session provides methods to retrieve JobProcessor
to Foundry
mappings. A JobProcessor
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 |
canLookupJobProcessorFoundryMappings()
Tests if this user can perform lookups of job processor/foundry
mappings.
|
IdList |
getFoundryIdsByJobProcessor(Id jobProcessorId)
Gets the
Foundry Ids mapped to a
JobProcessor. |
FoundryList |
getFoundrysByJobProcessor(Id jobProcessorId)
Gets the
Foundries mapped to a JobProcessor. |
IdList |
getJobProcessorIdsByFoundries(IdList foundryIds)
Gets the list of
JobProcessor Ids corresponding to a
list of Foundries. |
IdList |
getJobProcessorIdsByFoundry(Id foundryId)
Gets the list of
JobProcessorIds associated with a
Foundry. |
JobProcessorList |
getJobProcessorsByFoundries(IdList foundryIds)
Gets the list of job processor corresponding to a list of
Foundries. |
JobProcessorList |
getJobProcessorsByFoundry(Id foundryId)
Gets the list of job processors associated with a
Foundry. |
void |
useComparativeJobProcessorFoundryView()
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 |
usePlenaryJobProcessorFoundryView()
A complete view of the
JobProcessor and Foundry
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupJobProcessorFoundryMappings()
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 useComparativeJobProcessorFoundryView()
mandatory
- This method is must be implemented. void usePlenaryJobProcessorFoundryView()
JobProcessor
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 getJobProcessorIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorIds
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. JobProcessorList getJobProcessorsByFoundry(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 getJobProcessorIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
JobProcessor 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. JobProcessorList getJobProcessorsByFoundries(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 getFoundryIdsByJobProcessor(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to a
JobProcessor.
jobProcessorId
- Id
of a JobProcessor
NotFoundException
- jobProcessorId
is
not foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundrysByJobProcessor(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to a JobProcessor.
jobProcessorId
- Id
of a JobProcessor
NotFoundException
- jobProcessorId
is
not foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.