public interface JobProcessorEnablerQuerySession extends OsidSession
This session provides methods for searching among
JobProcessorEnabler
objects. The search query is constructed using
the JobProcessorEnablerQuery.
This session defines views that offer differing behaviors for searching.
Job processor enablers may have a query record indicated by their
respective record types. The query record is accessed via the
JobProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchJobProcessorEnablers()
Tests if this user can perform
JobProcessorEnabler
lookups. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobProcessorEnablerQuery |
getJobProcessorEnablerQuery()
Gets a job processor enabler query.
|
JobProcessorEnablerList |
getJobProcessorEnablersByQuery(JobProcessorEnablerQuery jobProcessorEnablerQuery)
Gets a list of
JobProcessorEnablers matching the given
job processor enabler 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 canSearchJobProcessorEnablers()
JobProcessorEnabler
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. JobProcessorEnablerQuery getJobProcessorEnablerQuery()
mandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersByQuery(JobProcessorEnablerQuery jobProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
JobProcessorEnablers
matching the given
job processor enabler query.jobProcessorEnablerQuery
- the job processor enabler query JobProcessorEnablerList
NullArgumentException
- jobProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobProcessorEnablerQuery
is not of this servicemandatory
- This method must be implemented.