org.osid.workflow

Interface WorkSmartOfficeSession

All Superinterfaces:

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

public interface WorkSmartOfficeSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A WorkQuery can be retrieved from this session and mapped to this Office to create a virtual collection of Works. The works may be sequenced using the WorkSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyWorkQuery(WorkQuery workQuery) Applies a work query to this office.
void	applyWorkSequencing(WorkSearchOrder workSearchOrder) Applies a work 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.
WorkQuery	getWorkQuery() Gets a work query.
WorkQuery	getWorkQueryFromInspector(WorkQueryInspector workQueryInspector) Gets a work query from an inspector.
WorkSearchOrder	getWorkSearchOrder() Gets a work search order.
WorkQueryInspector	inspectWorkQuery() Gets a work 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.

getWorkQuery

WorkQuery getWorkQuery()

Gets a work query.

Returns:

the work query

Compliance:

mandatory - This method must be implemented.

getWorkSearchOrder

WorkSearchOrder getWorkSearchOrder()

Gets a work search order.

Returns:

the work search order

Compliance:

mandatory - This method must be implemented.

applyWorkQuery

void applyWorkQuery(WorkQuery workQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a work query to this office.

Parameters:

workQuery - the work query

Throws:

NullArgumentException - workQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - workQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectWorkQuery

WorkQueryInspector inspectWorkQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a work query inspector for this office.

Returns:

the work query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyWorkSequencing

void applyWorkSequencing(WorkSearchOrder workSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a work search order to this office.

Parameters:

workSearchOrder - the work search order

Throws:

NullArgumentException - workSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - workSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getWorkQueryFromInspector

WorkQuery getWorkQueryFromInspector(WorkQueryInspector workQueryInspector)

Gets a work query from an inspector.

Parameters:

workQueryInspector - a work query inspector

Returns:

the work query

Throws:

NullArgumentException - workQueryInspector is null

UnsupportedException - workQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.