public interface JobProcessorQuerySession extends OsidSession
This session provides methods for searching among JobProcessor
objects. The search query is constructed using the
JobProcessorQuery.
This session defines views that offer differing behaviors for searching.
Job processors may have a job processor query record indicated by
their respective record types. The job processor query record is accessed
via the JobProcessorQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchJobProcessors()
Tests if this user can perform
JobProcessor lookups. |
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.
|
JobProcessorList |
getJobProcessorsByQuery(JobProcessorQuery jobProcessorQuery)
Gets a list of
JobProcessors matching the given job
processor query. |
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
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 canSearchJobProcessors()
JobProcessor
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. JobProcessorQuery getJobProcessorQuery()
mandatory
- This method must be implemented. JobProcessorList getJobProcessorsByQuery(JobProcessorQuery jobProcessorQuery) throws OperationFailedException, PermissionDeniedException
JobProcessors
matching the given job
processor query.jobProcessorQuery
- the job processor query JobProcessorList
NullArgumentException
- jobProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobProcessorQuery
is not of this servicemandatory
- This method must be implemented.