org.osid.workflow.rules

Interface ProcessEnablerSmartOfficeSession

All Superinterfaces:

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

public interface ProcessEnablerSmartOfficeSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic offices. A ProcessEnablerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of process enablers. The process enabler may be sequenced using the ProcessEnablerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProcessEnablerQuery(ProcessEnablerQuery processEnablerQuery) Applies a process enabler query to this office.
void	applyProcessEnablerSequencing(ProcessEnablerSearchOrder processEnablerSearchOrder) Applies a process enabler 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.
ProcessEnablerQuery	getProcessEnablerQuery() Gets a process enabler query.
ProcessEnablerQuery	getProcessEnablerQueryFromInspector(ProcessEnablerQueryInspector processEnablerQueryInspector) Gets a process enabler query from an inspector.
ProcessEnablerSearchOrder	getProcessEnablerSearchOrder() Gets a process enabler search order.
ProcessEnablerQueryInspector	inspectProcessEnablerQuery() Gets a process enabler 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.

getProcessEnablerQuery

ProcessEnablerQuery getProcessEnablerQuery()

Gets a process enabler query.

Returns:

the process enabler query

Compliance:

mandatory - This method must be implemented.

getProcessEnablerSearchOrder

ProcessEnablerSearchOrder getProcessEnablerSearchOrder()

Gets a process enabler search order.

Returns:

the process enabler search order

Compliance:

mandatory - This method must be implemented.

applyProcessEnablerQuery

void applyProcessEnablerQuery(ProcessEnablerQuery processEnablerQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a process enabler query to this office.

Parameters:

processEnablerQuery - the process enabler query

Throws:

NullArgumentException - processEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - processEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProcessEnablerQuery

ProcessEnablerQueryInspector inspectProcessEnablerQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets a process enabler query inspector for this office.

Returns:

the process enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProcessEnablerSequencing

void applyProcessEnablerSequencing(ProcessEnablerSearchOrder processEnablerSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a process enabler search order to this office.

Parameters:

processEnablerSearchOrder - the process enabler search order

Throws:

NullArgumentException - processEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - processEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProcessEnablerQueryFromInspector

ProcessEnablerQuery getProcessEnablerQueryFromInspector(ProcessEnablerQueryInspector processEnablerQueryInspector)

Gets a process enabler query from an inspector.

Parameters:

processEnablerQueryInspector - a process enabler query inspector

Returns:

the process enabler query

Throws:

NullArgumentException - processEnablerQueryInspector is null

UnsupportedException - processEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.