public interface JobProcessorRuleApplicationSession extends OsidSession
This session provides methods to apply JobProcessors
to
Jobs.
Modifier and Type | Method and Description |
---|---|
void |
assignJobProcessorToJob(Id jobProcessorId,
Id jobId)
Adds an existing
JobProcessor to a Job. |
boolean |
canAssignJobProcessors()
Tests if this user can alter job processor/job mappings.
|
boolean |
canSequenceJobProcessors()
Tests if this user can order
JobProcessors. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
moveJobProcessorAhead(Id jobProcessorId,
Id jobId,
Id referenceId)
Reorders job processors for a job by moving the specified job enabler
in front of a reference job processor.
|
void |
moveJobProcessorBehind(Id jobProcessorId,
Id jobId,
Id referenceId)
Reorders job processors for a job by moving the specified job enabler
behind a reference job processor.
|
void |
orderJobProcessors(Id[] jobProcessorIds,
Id jobId)
Reorders a set of job processors for a job.
|
void |
unassignJobProcessorFromJob(Id jobProcessorId,
Id jobId)
Removes a
JobProcessor from a Job. |
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 canAssignJobProcessors()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignJobProcessorToJob(Id jobProcessorId, Id jobId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessor
to a Job.
jobProcessorId
- the Id
of the
JobProcessor
jobId
- the Id
of the Job
AlreadyExistsException
- jobProcessorId
is already applied to jobId
NotFoundException
- jobProcessorId
or
jobId
not foundNullArgumentException
- jobProcessorId
or jobId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignJobProcessorFromJob(Id jobProcessorId, Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessor
from a Job.
jobProcessorId
- the Id
of the
JobProcessor
jobId
- the Id
of the Job
NotFoundException
- jobProcessorId
or
jobId
not found or jobProcessorId
not applied to jobId
NullArgumentException
- jobProcessorId
or jobId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceJobProcessors()
JobProcessors.
A return of
true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if JobProcessor
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveJobProcessorAhead(Id jobProcessorId, Id jobId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobProcessorId
- the Id
of a JobProcessor
jobId
- the Id
of a Job
referenceId
- the reference job processor Id
NotFoundException
- jobProcessorId, jobId,
or referenceId
not found or,
jobProcessorId
or referenceId
not
related to jobId
NullArgumentException
- jobProcessorId, jobId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveJobProcessorBehind(Id jobProcessorId, Id jobId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobProcessorId
- the Id
of a JobProcessor
jobId
- the Id
of a Job
referenceId
- the reference job processor Id
NotFoundException
- jobProcessorId, jobId,
or referenceId
not found or,
jobProcessorId
or referenceId
not
related to jobId
NullArgumentException
- jobProcessorId, jobId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderJobProcessors(Id[] jobProcessorIds, Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobProcessorIds
- the Ids
for a set of
JobProcessor
jobId
- the Id
of a Job
NotFoundException
- jobId
not found or,
a jobProcessorId
not related to jobId
NullArgumentException
- jobProcessorIds
or jobId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.