public interface PeriodSmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PeriodQuery
can be retrieved from this session
and mapped to this Business
to create a virtual collection
of Periods.
The periods may be sequenced using the
PeriodSearchOrder
from this session.
This Business
has a default query that matches any
period and a default search order that specifies no sequencing. The
queries may be examined using a PeriodQueryInspector.
The
query may be modified by converting the inspector back to a
PeriodQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPeriodQuery(PeriodQuery periodQuery)
Applies a period query to this business.
|
void |
applyPeriodSequencing(PeriodSearchOrder periodSearchOrder)
Applies a period search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
PeriodQuery |
getPeriodQuery()
Gets a period query.
|
PeriodQuery |
getPeriodQueryFromInspector(PeriodQueryInspector periodQueryInspector)
Gets a period query from an inspector.
|
PeriodSearchOrder |
getPeriodSearchOrder()
Gets a period search order.
|
PeriodQueryInspector |
inspectPeriodQuery()
Gets a period query inspector for this business.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartBusinesses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart business management is not
authorized, true
otherwisemandatory
- This method must be implemented. PeriodQuery getPeriodQuery()
mandatory
- This method must be implemented. PeriodSearchOrder getPeriodSearchOrder()
mandatory
- This method must be implemented. void applyPeriodQuery(PeriodQuery periodQuery) throws OperationFailedException, PermissionDeniedException
periodQuery
- the period queryNullArgumentException
- periodQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- periodQuery
not
of this servicemandatory
- This method must be implemented. PeriodQueryInspector inspectPeriodQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPeriodSequencing(PeriodSearchOrder periodSearchOrder) throws OperationFailedException, PermissionDeniedException
periodSearchOrder
- the period search orderNullArgumentException
- periodSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- periodSearchOrder
not of this servicemandatory
- This method must be implemented. PeriodQuery getPeriodQueryFromInspector(PeriodQueryInspector periodQueryInspector)
periodQueryInspector
- a query inspectorNullArgumentException
- periodQueryInspector
is null
UnsupportedException
- periodQueryInspector
is not of this servicemandatory
- This method must be implemented.