org.osid.workflow

Interface StepSmartOfficeSession

All Superinterfaces:

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

public interface StepSmartOfficeSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A StepQuery can be retrieved from this session and mapped to this Office to create a virtual collection of Steps. The step may be sequenced using the StepSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyStepQuery(StepQuery stepQuery) Applies a step query to this office.
void	applyStepSequencing(StepSearchOrder stepSearchOrder) Applies a step 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.
StepQuery	getStepQuery() Gets a step query.
StepQuery	getStepQueryFromInspector(StepQueryInspector stepQueryInspector) Gets a step query from an inspector.
StepSearchOrder	getStepSearchOrder() Gets a step search order.
StepQueryInspector	inspectStepQuery() Gets a step 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.

getStepQuery

StepQuery getStepQuery()

Gets a step query.

Returns:

the step query

Compliance:

mandatory - This method must be implemented.

getStepSearchOrder

StepSearchOrder getStepSearchOrder()

Gets a step search order.

Returns:

the step search order

Compliance:

mandatory - This method must be implemented.

applyStepQuery

void applyStepQuery(StepQuery stepQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a step query to this office.

Parameters:

stepQuery - the step query

Throws:

NullArgumentException - stepQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - stepQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectStepQuery

StepQueryInspector inspectStepQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a step query inspector for this office.

Returns:

the step query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyStepSequencing

void applyStepSequencing(StepSearchOrder stepSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a step search order to this office.

Parameters:

stepSearchOrder - the step search order

Throws:

NullArgumentException - stepSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - stepSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getStepQueryFromInspector

StepQuery getStepQueryFromInspector(StepQueryInspector stepQueryInspector)

Gets a step query from an inspector.

Parameters:

stepQueryInspector - a step query inspector

Returns:

the step query

Throws:

NullArgumentException - stepQueryInspector is null

UnsupportedException - stepQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.