public interface StepProcessorSmartOfficeSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
office. a StepProcessorQuery
can be retrieved from this
session and mapped to this Office
to create a virtual
collection of step processors. The step processor may be sequenced using
the StepProcessorSearchOrder
from this session.
This Office
has a default query that matches any step
processor and a default search order that specifies no sequencing. The
queries may be examined using a StepProcessorQueryInspector.
The query may be modified by converting the inspector back to a
StepProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyStepProcessorQuery(StepProcessorQuery stepProcessorQuery)
Applies a step processor query to this office.
|
void |
applyStepProcessorSequencing(StepProcessorSearchOrder stepProcessorSearchOrder)
Applies a step processor 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. |
StepProcessorQuery |
getStepProcessorQuery()
Gets a step processor query.
|
StepProcessorQuery |
getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)
Gets a step processor query from an inspector.
|
StepProcessorSearchOrder |
getStepProcessorSearchOrder()
Gets a step processor search order.
|
StepProcessorQueryInspector |
inspectStepProcessorQuery()
Gets a step processor query inspector for this office.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartOffices()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart office management is not
authorized, true
otherwisemandatory
- This method must be implemented. StepProcessorQuery getStepProcessorQuery()
mandatory
- This method must be implemented. StepProcessorSearchOrder getStepProcessorSearchOrder()
mandatory
- This method must be implemented. void applyStepProcessorQuery(StepProcessorQuery stepProcessorQuery) throws OperationFailedException, PermissionDeniedException
stepProcessorQuery
- the step processor queryNullArgumentException
- stepProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- stepProcessorQuery
not of this servicemandatory
- This method must be implemented. StepProcessorQueryInspector inspectStepProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyStepProcessorSequencing(StepProcessorSearchOrder stepProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
stepProcessorSearchOrder
- the step processor search orderNullArgumentException
- stepProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- stepProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. StepProcessorQuery getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)
stepProcessorQueryInspector
- a step processor query inspectorNullArgumentException
-
stepProcessorQueryInspector
is null
UnsupportedException
-
stepProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.