Interface JobProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply JobProcessors to Jobs .

Method Summary

Modifier and Type	Method	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 .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
            throws OperationFailedException,
PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignJobProcessors

boolean canAssignJobProcessors()

Tests if this user can alter job processor/job mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignJobProcessorToJob

void assignJobProcessorToJob(Id jobProcessorId,
 Id jobId)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing JobProcessor to a Job .

Parameters:

jobProcessorId - the Id of the JobProcessor

jobId - the Id of the Job

Throws:

AlreadyExistsException - jobProcessorId is already applied to jobId

NotFoundException - jobProcessorId or jobId not found

NullArgumentException - jobProcessorId or jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobProcessorFromJob

void unassignJobProcessorFromJob(Id jobProcessorId,
 Id jobId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a JobProcessor from a Job .

Parameters:

jobProcessorId - the Id of the JobProcessor

jobId - the Id of the Job

Throws:

NotFoundException - jobProcessorId or jobId not found or jobProcessorId not applied to jobId

NullArgumentException - jobProcessorId or jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceJobProcessors

boolean canSequenceJobProcessors()

Tests if this user can order 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.

Returns:

false if JobProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveJobProcessorAhead

void moveJobProcessorAhead(Id jobProcessorId,
 Id jobId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders job processors for a job by moving the specified job enabler in front of a reference job processor.

Parameters:

jobProcessorId - the Id of a JobProcessor

jobId - the Id of a Job

referenceId - the reference job processor Id

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveJobProcessorBehind

void moveJobProcessorBehind(Id jobProcessorId,
 Id jobId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders job processors for a job by moving the specified job enabler behind a reference job processor.

Parameters:

jobProcessorId - the Id of a JobProcessor

jobId - the Id of a Job

referenceId - the reference job processor Id

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderJobProcessors

void orderJobProcessors(Id[] jobProcessorIds,
 Id jobId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of job processors for a job.

Parameters:

jobProcessorIds - the Ids for a set of JobProcessor

jobId - the Id of a Job

Throws:

NotFoundException - jobId not found or, a jobProcessorId not related to jobId

NullArgumentException - jobProcessorIds or jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.