org.osid.workflow

Interface ProcessSmartOfficeSession

All Superinterfaces:

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

public interface ProcessSmartOfficeSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProcessQuery can be retrieved from this session and mapped to this Office to create a virtual collection of Processes. The process may be sequenced using the ProcessSearchOrder from this session.

This Office has a default query that matches any process and a default search order that specifies no sequencing. The queries may be examined using a ProcessQueryInspector. The query may be modified by converting the inspector back to a ProcessQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProcessQuery(ProcessQuery processQuery) Applies a process query to this office.
void	applyProcessSequencing(ProcessSearchOrder processSearchOrder) Applies a process search order to this office.
boolean	canManageSmartOffices() Tests if this user can manage smart offices.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
ProcessQuery	getProcessQuery() Gets a process query.
ProcessQuery	getProcessQueryFromInspector(ProcessQueryInspector processQueryInspector) Gets a process query from an inspector.
ProcessSearchOrder	getProcessSearchOrder() Gets a process search order.
ProcessQueryInspector	inspectProcessQuery() Gets a process query inspector for this office.

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

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartOffices

boolean canManageSmartOffices()

Tests if this user can manage smart offices. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart office management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getProcessQuery

ProcessQuery getProcessQuery()

Gets a process query.

Returns:

the process query

Compliance:

mandatory - This method must be implemented.

getProcessSearchOrder

ProcessSearchOrder getProcessSearchOrder()

Gets a process search order.

Returns:

the process search order

Compliance:

mandatory - This method must be implemented.

applyProcessQuery

void applyProcessQuery(ProcessQuery processQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Applies a process query to this office.

Parameters:

processQuery - the process query

Throws:

NullArgumentException - processQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - processQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProcessQuery

ProcessQueryInspector inspectProcessQuery()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a process query inspector for this office.

Returns:

the process query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProcessSequencing

void applyProcessSequencing(ProcessSearchOrder processSearchOrder)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a process search order to this office.

Parameters:

processSearchOrder - the process search order

Throws:

NullArgumentException - processSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - processSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProcessQueryFromInspector

ProcessQuery getProcessQueryFromInspector(ProcessQueryInspector processQueryInspector)

Gets a process query from an inspector.

Parameters:

processQueryInspector - a process query inspector

Returns:

the process query

Throws:

NullArgumentException - processQueryInspector is null

UnsupportedException - processQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.