public interface JobSmartFoundrySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A JobQuery
can be retrieved from this session and
mapped to this Foundry
to create a virtual collection of
Jobs.
The jobs may be sequenced using the
JobSearchOrder
from this session.
This Foundry
has a default query that matches any job
and a default search order that specifies no sequencing. The queries may
be examined using a JobQueryInspector.
The query may be
modified by converting the inspector back to a JobQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyJobQuery(JobQuery jobQuery)
Applies a job query to this foundry.
|
void |
applyJobSequencing(JobSearchOrder jobSearchOrder)
Applies a job 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. |
JobQuery |
getJobQuery()
Gets a job query.
|
JobQuery |
getJobQueryFromInspector(JobQueryInspector jobQueryInspector)
Gets a job query from an inspector.
|
JobSearchOrder |
getJobSearchOrder()
Gets a job search order.
|
JobQueryInspector |
inspectJobQuery()
Gets a job 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. JobQuery getJobQuery()
mandatory
- This method must be implemented. JobSearchOrder getJobSearchOrder()
mandatory
- This method must be implemented. void applyJobQuery(JobQuery jobQuery) throws OperationFailedException, PermissionDeniedException
jobQuery
- the job queryNullArgumentException
- jobQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- jobQuery
not of
this servicemandatory
- This method must be implemented. JobQueryInspector inspectJobQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyJobSequencing(JobSearchOrder jobSearchOrder) throws OperationFailedException, PermissionDeniedException
jobSearchOrder
- the job search orderNullArgumentException
- jobSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- jobSearchOrder
not of this servicemandatory
- This method must be implemented. JobQuery getJobQueryFromInspector(JobQueryInspector jobQueryInspector)
jobQueryInspector
- a job query inspectorNullArgumentException
- jobQueryInspector
is null
UnsupportedException
- jobQueryInspector
is not of this servicemandatory
- This method must be implemented.