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.
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.
|
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. StepQuery getStepQuery()
mandatory
- This method must be implemented. StepSearchOrder getStepSearchOrder()
mandatory
- This method must be implemented. void applyStepQuery(StepQuery stepQuery) throws OperationFailedException, PermissionDeniedException
stepQuery
- the step queryNullArgumentException
- stepQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- stepQuery
not of
this servicemandatory
- This method must be implemented. StepQueryInspector inspectStepQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyStepSequencing(StepSearchOrder stepSearchOrder) throws OperationFailedException, PermissionDeniedException
stepSearchOrder
- the step search orderNullArgumentException
- stepSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- stepSearchOrder
not of this servicemandatory
- This method must be implemented. StepQuery getStepQueryFromInspector(StepQueryInspector stepQueryInspector)
stepQueryInspector
- a step query inspectorNullArgumentException
- stepQueryInspector
is null
UnsupportedException
- stepQueryInspector
is not of this servicemandatory
- This method must be implemented.