public interface JobConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve JobConstrainer
to Job
mappings. A Job
with multiple
JobConstrainers
means any positive rule evaluation across the
result in an effective Job.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupJobConstrainerRules()
Tests if this user can perform lookups of job constrainer/job
mappings.
|
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
IdList |
getJobConstrainerIdsForJob(Id jobId)
Gets the
JobConstrainer Id associated with a
Job. |
JobConstrainerList |
getJobConstrainersForJob(Id jobId)
Gets the
JobConstrainer associated with a Job. |
IdList |
getJobIdsForJobConstrainer(Id jobConstrainerId)
Gets the
Job Ids mapped to a
JobConstrainer. |
JobList |
getJobsForJobConstrainer(Id jobConstrainerId)
Gets the
Jobs mapped to a JobConstrainer. |
void |
useComparativeJobConstrainerRuleView()
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 |
usePlenaryJobConstrainerRuleView()
A complete view of the
JobConstrainer and Job
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 canLookupJobConstrainerRules()
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 useComparativeJobConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryJobConstrainerRuleView()
JobConstrainer
and Job
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 getJobConstrainerIdsForJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainer Id
associated with a
Job.
jobId
- Id
of the Job
Ids
NotFoundException
- jobId
is not foundNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobConstrainerList getJobConstrainersForJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainer
associated with a Job.
jobId
- Id
of the Job
NotFoundException
- jobId
is not foundNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getJobIdsForJobConstrainer(Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Job
Ids
mapped to a
JobConstrainer.
jobConstrainerId
- Id
of a JobConstrainer
Ids
NotFoundException
- jobConstrainerId
is
not foundNullArgumentException
- jobConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobList getJobsForJobConstrainer(Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Jobs
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.