Interface JobConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobConstrainerRuleApplicationSession
extends OsidSession

This session provides methods to apply JobConstrainers to Jobs . A Job with multiple JobConstrainers means any positive rule evaluation across the result in an effective Job .

Method Summary

Modifier and Type	Method	Description
void	assignJobConstrainerToJob(Id jobConstrainerId, Id jobId)	Adds an existing JobConstrainer to a Job .
boolean	canAssignJobConstrainers()	Tests if this user can alter job constrainer/job mappings.
boolean	canSequenceJobConstrainers()	Tests if this user can order JobConstrainers .
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	moveJobConstrainerAhead(Id jobConstrainerId, Id jobId, Id referenceId)	Reorders job constrainers for a job constrainer by moving the specified job constrainer in front of a reference job constrainer.
void	moveJobConstrainerBehind(Id jobConstrainerId, Id jobId, Id referenceId)	Reorders job constrainers for a job constrainer by moving the specified job constrainer behind a reference job constrainer.
void	orderJobConstrainers(Id[] jobConstrainerIds, Id jobId)	Reorders a set of job constrainer for a job.
void	unassignJobConstrainerFromJob(Id jobConstrainerId, Id jobId)	Removes a JobConstrainer 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.

canAssignJobConstrainers

boolean canAssignJobConstrainers()

Tests if this user can alter job constrainer/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.

assignJobConstrainerToJob

void assignJobConstrainerToJob(Id jobConstrainerId,
 Id jobId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing JobConstrainer to a Job .

Parameters:

jobConstrainerId - the Id of the JobConstrainer

jobId - the Id of the Job

Throws:

AlreadyExistsException - jobConstrainerId is already applied to jobId

NotFoundException - jobConstrainerId or jobId not found

NullArgumentException - jobConstrainerId or jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobConstrainerFromJob

void unassignJobConstrainerFromJob(Id jobConstrainerId,
 Id jobId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a JobConstrainer from a Job .

Parameters:

jobConstrainerId - the Id of the JobConstrainer

jobId - the Id of the Job

Throws:

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

NullArgumentException - jobConstrainerId or jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceJobConstrainers

boolean canSequenceJobConstrainers()

Tests if this user can order JobConstrainers . 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 JobConstrainer ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveJobConstrainerAhead

void moveJobConstrainerAhead(Id jobConstrainerId,
 Id jobId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders job constrainers for a job constrainer by moving the specified job constrainer in front of a reference job constrainer.

Parameters:

jobConstrainerId - the Id of a JobConstrainer

jobId - the Id of a Job

referenceId - the reference job constrainer Id

Throws:

NotFoundException - jobConstrainerId, jobId , or referenceId not found or, jobConstrainerId or referenceId not related to jobId

NullArgumentException - jobConstrainerId, jobId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveJobConstrainerBehind

void moveJobConstrainerBehind(Id jobConstrainerId,
 Id jobId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders job constrainers for a job constrainer by moving the specified job constrainer behind a reference job constrainer.

Parameters:

jobConstrainerId - the Id of a JobConstrainer

jobId - the Id of a Job

referenceId - the reference job constrainer Id

Throws:

NotFoundException - jobConstrainerId, jobId , or referenceId not found or, jobConstrainerId or referenceId not related to jobId

NullArgumentException - jobConstrainerId, jobId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderJobConstrainers

void orderJobConstrainers(Id[] jobConstrainerIds,
 Id jobId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of job constrainer for a job.

Parameters:

jobConstrainerIds - the Ids for a set of JobConstrainers

jobId - the Id of a Job

Throws:

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

NullArgumentException - jobConstrainerIds or jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.