org.osid.workflow.rules

Interface StepProcessorEnablerSmartOfficeSession

All Superinterfaces:

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

public interface StepProcessorEnablerSmartOfficeSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic office. a StepProcessorEnablerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of step processor enablers. The step processor enablers may be sequenced using the StepProcessorEnablerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyStepProcessorEnablerQuery(StepProcessorEnablerQuery stepProcessorEnablerQuery) Applies a step processor enabler query to this office.
void	applyStepProcessorEnablerSequencing(StepProcessorEnablerSearchOrder stepProcessorEnablerSearchOrder) Applies a step processor enabler search order to this office.
boolean	canManageSmartOffices() Tests if this user can manage smart office.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
StepProcessorEnablerQuery	getStepProcessorEnablerQuery() Gets a step processor enabler query.
StepProcessorEnablerQuery	getStepProcessorEnablerQueryFromInspector(StepProcessorEnablerQueryInspector stepProcessorEnablerQueryInspector) Gets a step processor enabler query from an inspector.
StepProcessorEnablerSearchOrder	getStepProcessorEnablerSearchOrder() Gets a step processor enabler search order.
StepProcessorEnablerQueryInspector	inspectStepProcessorEnablerQuery() Gets a step processor 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 office. 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.

getStepProcessorEnablerQuery

StepProcessorEnablerQuery getStepProcessorEnablerQuery()

Gets a step processor enabler query.

Returns:

the step processor enabler query

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablerSearchOrder

StepProcessorEnablerSearchOrder getStepProcessorEnablerSearchOrder()

Gets a step processor enabler search order.

Returns:

the step processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyStepProcessorEnablerQuery

void applyStepProcessorEnablerQuery(StepProcessorEnablerQuery stepProcessorEnablerQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a step processor enabler query to this office.

Parameters:

stepProcessorEnablerQuery - the step processor enabler query

Throws:

NullArgumentException - stepProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - stepProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectStepProcessorEnablerQuery

StepProcessorEnablerQueryInspector inspectStepProcessorEnablerQuery()
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

Gets a step processor enabler query inspector for this office.

Returns:

the step processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyStepProcessorEnablerSequencing

void applyStepProcessorEnablerSequencing(StepProcessorEnablerSearchOrder stepProcessorEnablerSearchOrder)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies a step processor enabler search order to this office.

Parameters:

stepProcessorEnablerSearchOrder - the step processor enabler search order

Throws:

NullArgumentException - stepProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - stepProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablerQueryFromInspector

StepProcessorEnablerQuery getStepProcessorEnablerQueryFromInspector(StepProcessorEnablerQueryInspector stepProcessorEnablerQueryInspector)

Gets a step processor enabler query from an inspector.

Parameters:

stepProcessorEnablerQueryInspector - a step processor enabler query inspector

Returns:

the step processor enabler query

Throws:

NullArgumentException - stepProcessorEnablerQueryInspector is null

UnsupportedException - stepProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.