org.osid.process

Interface ProcessQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

ProcessSearchSession

public interface ProcessQuerySession
extends OsidSession

This session provides methods for searching among Process objects. The search query is constructed using the ProcessQuery.

Processes may have a query record indicated by their respective record types. The query record is accessed via the ProcessQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchProcesses() Tests if this user can perform Process searches.
ProcessList	getProcessesByQuery(ProcessQuery processQuery) Gets a list of Processes matching the given process query.
ProcessQuery	getProcessQuery() Gets a process query.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canSearchProcesses

boolean canSearchProcesses()

Tests if this user can perform Process searches. 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 opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getProcessQuery

ProcessQuery getProcessQuery()

Gets a process query. The returned query will not have an extension query.

Returns:

the process query

Compliance:

mandatory - This method must be implemented.

getProcessesByQuery

ProcessList getProcessesByQuery(ProcessQuery processQuery)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a list of Processes matching the given process query.

Parameters:

processQuery - the process query

Returns:

the returned ProcessList

Throws:

NullArgumentException - processQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - a processQuery is not of this service

Compliance:

mandatory - This method must be implemented.