Interface JobProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply JobProcessorEnablers to JobProcessors . A JobProcessor with multiple JobProcessorEnablers means any positive rule evaluation across the enablers result in an effective JobProcessor .

Method Summary

Modifier and Type	Method	Description
void	assignJobProcessorEnablerToJobProcessor(Id jobProcessorEnablerId, Id jobProcessorId)	Adds an existing JobProcessorEnabler to a JobProcessor .
boolean	canAssignJobProcessorEnablers()	Tests if this user can alter job processor enabler/job processor mappings.
boolean	canSequenceJobProcessorEnablers()	Tests if this user can order JobProcessorEnablers .
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	moveJobProcessorEnablerAhead(Id jobProcessorEnablerId, Id jobProcessorId, Id referenceId)	Reorders job processor enablers for a job processor by moving the specified job processor enabler in front of a reference job processor enabler.
void	moveJobProcessorEnablerBehind(Id jobProcessorEnablerId, Id jobProcessorId, Id referenceId)	Reorders job processor enablers for a job processor by moving the specified job processor enabler behind a reference job processor enabler.
void	orderJobProcessorEnablers(Id[] jobProcessorEnablerIds, Id jobProcessorId)	Reorders a set of job processor enablers for a job processor.
void	unassignJobProcessorEnablerFromJobProcessor(Id jobProcessorEnablerId, Id jobProcessorId)	Removes a JobProcessorEnabler from a JobProcessor .

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.

canAssignJobProcessorEnablers

boolean canAssignJobProcessorEnablers()

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

assignJobProcessorEnablerToJobProcessor

void assignJobProcessorEnablerToJobProcessor(Id jobProcessorEnablerId,
 Id jobProcessorId)
                                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing JobProcessorEnabler to a JobProcessor .

Parameters:

jobProcessorEnablerId - the Id of the JobProcessorEnabler

jobProcessorId - the Id of the JobProcessor

Throws:

AlreadyExistsException - jobProcessorEnablerId is already applied to jobProcessorId

NotFoundException - jobProcessorEnablerId or jobProcessorId not found

NullArgumentException - jobProcessorEnablerId or jobProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobProcessorEnablerFromJobProcessor

void unassignJobProcessorEnablerFromJobProcessor(Id jobProcessorEnablerId,
 Id jobProcessorId)
                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a JobProcessorEnabler from a JobProcessor .

Parameters:

jobProcessorEnablerId - the Id of the JobProcessorEnabler

jobProcessorId - the Id of the JobProcessor

Throws:

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

NullArgumentException - jobProcessorEnablerId or jobProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceJobProcessorEnablers

boolean canSequenceJobProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveJobProcessorEnablerAhead

void moveJobProcessorEnablerAhead(Id jobProcessorEnablerId,
 Id jobProcessorId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerId - the Id of a JobProcessorEnabler

jobProcessorId - the Id of a JobProcessor

referenceId - the reference job processor enabler Id

Throws:

NotFoundException - jobProcessorEnablerId, jobProcessorId , or referenceId not found or, jobProcessorEnablerId or referenceId not related to jobProcessorId

NullArgumentException - jobProcessorEnablerId, jobProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveJobProcessorEnablerBehind

void moveJobProcessorEnablerBehind(Id jobProcessorEnablerId,
 Id jobProcessorId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerId - the Id of a JobProcessorEnabler

jobProcessorId - the Id of a JobProcessor

referenceId - the reference job processor enabler Id

Throws:

NotFoundException - jobProcessorEnablerId, jobProcessorId , or referenceId not found or, jobProcessorEnablerId or referenceId not related to jobProcessorId

NullArgumentException - jobProcessorEnablerId, jobProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderJobProcessorEnablers

void orderJobProcessorEnablers(Id[] jobProcessorEnablerIds,
 Id jobProcessorId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of job processor enablers for a job processor.

Parameters:

jobProcessorEnablerIds - the Ids for a set of JobProcessorEnablers

jobProcessorId - the Id of a JobProcessor

Throws:

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

NullArgumentException - jobProcessorEnablerIds or jobProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.