public interface JobQuerySession extends OsidSession
This session provides methods for searching among Job
objects. The search query is constructed using the JobQuery.
This session defines views that offer differing behaviors for searching.
Jobs may have a query record indicated by their respective record
types. The query record is accessed via the JobQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchJobs()
Tests if this user can perform
Job lookups. |
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.
|
JobList |
getJobsByQuery(JobQuery jobQuery)
Gets a list of
Jobs matching the given job 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 canSearchJobs()
Job
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. JobQuery getJobQuery()
mandatory
- This method must be implemented. JobList getJobsByQuery(JobQuery jobQuery) throws OperationFailedException, PermissionDeniedException
Jobs
matching the given job query.jobQuery
- the job query JobList
NullArgumentException
- jobQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobQuery
is not
of this servicemandatory
- This method must be implemented.