public interface JobConstrainerFoundrySession extends OsidSession
This session provides methods to retrieve JobConstrainer
to Foundry
mappings. A JobConstrainer
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 |
canLookupJobConstrainerFoundryMappings()
Tests if this user can perform lookups of job constrainer/foundry
mappings.
|
IdList |
getFoundryIdsByJobConstrainer(Id jobConstrainerId)
Gets the
Foundry Ids mapped to a
JobConstrainer. |
FoundryList |
getFoundrysByJobConstrainer(Id jobConstrainerId)
Gets the
Foundries mapped to a JobConstrainer. |
IdList |
getJobConstrainerIdsByFoundries(IdList foundryIds)
Gets the list of
JobConstrainer Ids corresponding to a
list of Foundries. |
IdList |
getJobConstrainerIdsByFoundry(Id foundryId)
Gets the list of
JobConstrainerIds associated with a
Foundry. |
JobConstrainerList |
getJobConstrainersByFoundries(IdList foundryIds)
Gets the list of job constrainer corresponding to a list of
Foundries. |
JobConstrainerList |
getJobConstrainersByFoundry(Id foundryId)
Gets the list of job constrainer associated with a
Foundry. |
void |
useComparativeJobConstrainerFoundryView()
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 |
usePlenaryJobConstrainerFoundryView()
A complete view of the
JobConstrainer and
Foundry returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupJobConstrainerFoundryMappings()
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 useComparativeJobConstrainerFoundryView()
mandatory
- This method is must be implemented. void usePlenaryJobConstrainerFoundryView()
JobConstrainer
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 getJobConstrainerIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainerIds
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. JobConstrainerList getJobConstrainersByFoundry(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 getJobConstrainerIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
JobConstrainer 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. JobConstrainerList getJobConstrainersByFoundries(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 getFoundryIdsByJobConstrainer(Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to a
JobConstrainer.
jobConstrainerId
- Id
of a JobConstrainer
NotFoundException
- jobConstrainerId
is
not foundNullArgumentException
- jobConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundrysByJobConstrainer(Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to a JobConstrainer.
jobConstrainerId
- Id
of a JobConstrainer
NotFoundException
- jobConstrainerId
is
not foundNullArgumentException
- jobConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.