public interface ProcessEnablerQuerySession extends OsidSession
This session provides methods for searching among ProcessEnabler
objects. The search query is constructed using the
ProcessEnablerQuery.
This session defines views that offer differing behaviors for searching.
process enabler may have a query record indicated by their respective
record types. The query record is accessed via the
ProcessEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchProcessEnablers()
Tests if this user can perform
ProcessEnabler lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
ProcessEnablerQuery |
getProcessEnablerQuery()
Gets a process enabler query.
|
ProcessEnablerList |
getProcessEnablersByQuery(ProcessEnablerQuery processEnablerQuery)
Gets a list of
ProcessEnablers matching the given
process 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 canSearchProcessEnablers()
ProcessEnabler
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. ProcessEnablerQuery getProcessEnablerQuery()
mandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersByQuery(ProcessEnablerQuery processEnablerQuery) throws OperationFailedException, PermissionDeniedException
ProcessEnablers
matching the given
process enabler query.processEnablerQuery
- the process enabler query ProcessEnablerList
NullArgumentException
- processEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- processEnablerQuery
is not of this servicemandatory
- This method must be implemented.