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