public interface JobFoundrySession extends OsidSession
This session provides methods to retrieve Job
to
Foundry
resourcings. A Job
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 |
canLookupJobFoundryMappings()
Tests if this user can perform lookups of job/foundry resourcings.
|
FoundryList |
getFoundriesByJob(Id jobId)
Gets the
Foundries mapped to a Job. |
IdList |
getFoundryIdsByJob(Id jobId)
Gets the
Foundry Ids mapped to a
Job. |
IdList |
getJobIdsByFoundries(IdList foundryIds)
Gets the list of
Job Ids corresponding to a list of
Foundries. |
IdList |
getJobIdsByFoundry(Id foundryId)
Gets the list of
Job Ids associated with a
Foundry. |
JobList |
getJobsByFoundries(IdList foundryIds)
Gets the list of
Job corresponding to a list of
Foundries. |
JobList |
getJobsByFoundry(Id foundryId)
Gets the list of
Jobs associated with a Foundry. |
void |
useComparativeJobFoundryView()
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 |
usePlenaryJobFoundryView()
A complete view of the
Job and Foundry
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupJobFoundryMappings()
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 useComparativeJobFoundryView()
mandatory
- This method is must be implemented. void usePlenaryJobFoundryView()
Job
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 getJobIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Job Ids
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. JobList getJobsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Jobs
associated with a 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 getJobIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Job 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. JobList getJobsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Job
corresponding to a list of
Foundries.
foundryIds
- list of foundry Ids
NullArgumentException
- foundryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFoundryIdsByJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to a
Job.
jobId
- Id
of a Job
NotFoundException
- jobId
is not foundNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundriesByJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to a Job.
jobId
- Id
of a Job
NotFoundException
- jobId
is not foundNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.