public interface PostEntrySmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PostEntryQuery
can be retrieved from this
session and mapped to this Business
to create a virtual
collection of PostEntries.
The post entries may be
sequenced using the PostEntrySearchOrder
from this session.
This Business
has a default query that matches any post
entry and a default search order that specifies no sequencing. The queries
may be examined using a PostEntryQueryInspector.
The query
may be modified by converting the inspector back to a
PostEntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPostEntryQuery(PostEntryQuery postEntryQuery)
Applies a post entry query to this business.
|
void |
applyPostEntrySequencing(PostEntrySearchOrder postEntrySearchOrder)
Applies a post entry 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. |
PostEntryQuery |
getPostEntryQuery()
Gets a post entry query.
|
PostEntryQuery |
getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)
Gets a post entry query from an inspector.
|
PostEntrySearchOrder |
getPostEntrySearchOrder()
Gets a post entry search order.
|
PostEntryQueryInspector |
inspectPostEntryQuery()
Gets a post entry 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. PostEntryQuery getPostEntryQuery()
mandatory
- This method must be implemented. PostEntrySearchOrder getPostEntrySearchOrder()
mandatory
- This method must be implemented. void applyPostEntryQuery(PostEntryQuery postEntryQuery) throws OperationFailedException, PermissionDeniedException
postEntryQuery
- the post entry queryNullArgumentException
- postEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- postEntryQuery
not of this servicemandatory
- This method must be implemented. PostEntryQueryInspector inspectPostEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPostEntrySequencing(PostEntrySearchOrder postEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
postEntrySearchOrder
- the post entry search orderNullArgumentException
- postEntrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- postEntrySearchOrder
not of this servicemandatory
- This method must be implemented. PostEntryQuery getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)
postEntryQueryInspector
- a query inspectorNullArgumentException
- postEntryQueryInspector
is null
UnsupportedException
- postEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.