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.
Modifier and Type | Method and 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. |
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 canAssignJobConstrainerEnablers()
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 assignJobConstrainerEnablerToJobConstrainer(Id jobConstrainerEnablerId, Id jobConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainerEnabler
to a
JobConstrainer.
jobConstrainerEnablerId
- the Id
of the
JobConstrainerEnabler
jobConstrainerId
- the Id
of the
JobConstrainer
AlreadyExistsException
- jobConstrainerEnablerId
is already applied to jobConstrainerId
NotFoundException
- jobConstrainerEnablerId
or jobConstrainerId
not foundNullArgumentException
- jobConstrainerEnablerId
or jobConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignJobConstrainerEnablerFromJobConstrainer(Id jobConstrainerEnablerId, Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainerEnabler
from a
JobConstrainer.
jobConstrainerEnablerId
- the Id
of the
JobConstrainerEnabler
jobConstrainerId
- the Id
of the
JobConstrainer
NotFoundException
- jobConstrainerEnablerId
or jobConstrainerId
not found or
jobConstrainerEnablerId
not applied to
jobConstrainerId
NullArgumentException
- jobConstrainerEnablerId
or jobConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceJobConstrainerEnablers()
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. false
if JobConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveJobConstrainerEnablerAhead(Id jobConstrainerEnablerId, Id jobConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobConstrainerEnablerId
- the Id
of a
JobConstrainerEnabler
jobConstrainerId
- the Id
of a
JobConstrainer
referenceId
- the reference job constrainer enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveJobConstrainerEnablerBehind(Id jobConstrainerEnablerId, Id jobConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobConstrainerEnablerId
- the Id
of a
JobConstrainerEnabler
jobConstrainerId
- the Id
of a
JobConstrainer
referenceId
- the reference job constrainer enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderJobConstrainerEnablers(Id[] jobConstrainerEnablerIds, Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobConstrainerEnablerIds
- the Ids
for a set of
JobConstrainerEnablers
jobConstrainerId
- the Id
of a
JobConstrainer
NotFoundException
- jobConstrainerId
not
found or, a jobConstrainerEnablerId
not related
to jobConstrainerId
NullArgumentException
- jobConstrainerEnablerIds
or jobConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.