Interface JobConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobConstrainerEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignJobConstrainerEnablerToJobConstrainer(Id jobConstrainerEnablerId, Id jobConstrainerId)	Adds an existing JobConstrainerEnabler to a JobConstrainer .
boolean	canAssignJobConstrainerEnablers()	Tests if this user can alter job constrainer enabler/job constrainer mappings.
boolean	canSequenceJobConstrainerEnablers()	Tests if this user can order JobConstrainerEnablers .
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	moveJobConstrainerEnablerAhead(Id jobConstrainerEnablerId, Id jobConstrainerId, Id referenceId)	Reorders job constrainer enablers for a job constrainer by moving the specified job constrainer enabler in front of a reference job constrainer enabler.
void	moveJobConstrainerEnablerBehind(Id jobConstrainerEnablerId, Id jobConstrainerId, Id referenceId)	Reorders job constrainer enablers for a job constrainer by moving the specified job constrainer enabler behind a reference job constrainer enabler.
void	orderJobConstrainerEnablers(Id[] jobConstrainerEnablerIds, Id jobConstrainerId)	Reorders a set of job constrainer enablers for a job constrainer.
void	unassignJobConstrainerEnablerFromJobConstrainer(Id jobConstrainerEnablerId, Id jobConstrainerId)	Removes a JobConstrainerEnabler from a JobConstrainer .

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.

canAssignJobConstrainerEnablers

boolean canAssignJobConstrainerEnablers()

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

assignJobConstrainerEnablerToJobConstrainer

void assignJobConstrainerEnablerToJobConstrainer(Id jobConstrainerEnablerId,
 Id jobConstrainerId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing JobConstrainerEnabler to a JobConstrainer .

Parameters:

jobConstrainerEnablerId - the Id of the JobConstrainerEnabler

jobConstrainerId - the Id of the JobConstrainer

Throws:

AlreadyExistsException - jobConstrainerEnablerId is already applied to jobConstrainerId

NotFoundException - jobConstrainerEnablerId or jobConstrainerId not found

NullArgumentException - jobConstrainerEnablerId or jobConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobConstrainerEnablerFromJobConstrainer

void unassignJobConstrainerEnablerFromJobConstrainer(Id jobConstrainerEnablerId,
 Id jobConstrainerId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a JobConstrainerEnabler from a JobConstrainer .

Parameters:

jobConstrainerEnablerId - the Id of the JobConstrainerEnabler

jobConstrainerId - the Id of the JobConstrainer

Throws:

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

NullArgumentException - jobConstrainerEnablerId or jobConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceJobConstrainerEnablers

boolean canSequenceJobConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveJobConstrainerEnablerAhead

void moveJobConstrainerEnablerAhead(Id jobConstrainerEnablerId,
 Id jobConstrainerId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerId - the Id of a JobConstrainerEnabler

jobConstrainerId - the Id of a JobConstrainer

referenceId - the reference job constrainer enabler Id

Throws:

NotFoundException - jobConstrainerEnablerId, jobConstrainenId , or referenceId not found or, jobConstrainerEnablerId or referenceId not related to jobConstrainerId

NullArgumentException - jobConstrainerEnablerId, jobConstrainerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveJobConstrainerEnablerBehind

void moveJobConstrainerEnablerBehind(Id jobConstrainerEnablerId,
 Id jobConstrainerId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerId - the Id of a JobConstrainerEnabler

jobConstrainerId - the Id of a JobConstrainer

referenceId - the reference job constrainer enabler Id

Throws:

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

NullArgumentException - jobConstrainerEnablerId, jobConstrainerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderJobConstrainerEnablers

void orderJobConstrainerEnablers(Id[] jobConstrainerEnablerIds,
 Id jobConstrainerId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerIds - the Ids for a set of JobConstrainerEnablers

jobConstrainerId - the Id of a JobConstrainer

Throws:

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

NullArgumentException - jobConstrainerEnablerIds or jobConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.