public interface StepProcessorEnablerQuerySession extends OsidSession
This session provides methods for searching among
StepProcessorEnabler
objects. The search query is constructed
using the StepProcessorEnablerQuery.
This session defines views that offer differing behaviors for searching.
Step processor enablers may have a query record indicated by their
respective record types. The query record is accessed via the
StepProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchStepProcessorEnablers()
Tests if this user can perform
StepProcessorEnabler
lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepProcessorEnablerQuery |
getStepProcessorEnablerQuery()
Gets a step processor enabler query.
|
StepProcessorEnablerList |
getStepProcessorEnablersByQuery(StepProcessorEnablerQuery stepProcessorEnablerQuery)
Gets a list of
StepProcessorEnablers matching the given
step processor enabler query. |
void |
useFederatedOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedOfficeView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchStepProcessorEnablers()
StepProcessorEnabler
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 useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. StepProcessorEnablerQuery getStepProcessorEnablerQuery()
mandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablersByQuery(StepProcessorEnablerQuery stepProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablers
matching the given
step processor enabler query.stepProcessorEnablerQuery
- the step processor enabler query StepProcessorEnablerList
NullArgumentException
-
stepProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepProcessorEnablerQuery
is not of this servicemandatory
- This method must be implemented.