public interface JobProcessorSmartFoundrySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
foundries. A JobProcessorQuery
can be retrieved from this
session and mapped to this Foundry
to create a virtual
collection of job processors. The job processor may be sequenced using the
JobProcessorSearchOrder
from this session.
This Foundry
has a default query that matches any job
processor and a default search order that specifies no sequencing. The
queries may be examined using a JobProcessorQueryInspector.
The query may be modified by converting the inspector back to a
JobProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyJobProcessorQuery(JobProcessorQuery jobProcessorQuery)
Applies a job processor query to this foundry.
|
void |
applyJobProcessorSequencing(JobProcessorSearchOrder jobProcessorSearchOrder)
Applies a job processor search order to this foundry.
|
boolean |
canManageSmartFoundries()
Tests if this user can manage smart foundries.
|
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobProcessorQuery |
getJobProcessorQuery()
Gets a job processor query.
|
JobProcessorQuery |
getJobProcessorQueryFromInspector(JobProcessorQueryInspector jobProcessorQueryInspector)
Gets a job processor query from an inspector.
|
JobProcessorSearchOrder |
getJobProcessorSearchOrder()
Gets a job processor search order.
|
JobProcessorQueryInspector |
inspectJobProcessorQuery()
Gets a job processor query inspector for this foundry.
|
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 canManageSmartFoundries()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart foundry management is not
authorized, true
otherwisemandatory
- This method must be implemented. JobProcessorQuery getJobProcessorQuery()
mandatory
- This method must be implemented. JobProcessorSearchOrder getJobProcessorSearchOrder()
mandatory
- This method must be implemented. void applyJobProcessorQuery(JobProcessorQuery jobProcessorQuery) throws OperationFailedException, PermissionDeniedException
jobProcessorQuery
- the job processor queryNullArgumentException
- jobProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- jobProcessorQuery
not of this servicemandatory
- This method must be implemented. JobProcessorQueryInspector inspectJobProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyJobProcessorSequencing(JobProcessorSearchOrder jobProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
jobProcessorSearchOrder
- the job processor search orderNullArgumentException
- jobProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- jobProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. JobProcessorQuery getJobProcessorQueryFromInspector(JobProcessorQueryInspector jobProcessorQueryInspector)
jobProcessorQueryInspector
- a job processor query inspectorNullArgumentException
-
jobProcessorQueryInspector
is null
UnsupportedException
-
jobProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.