public interface PostQuerySession extends OsidSession
This session provides methods for searching among Post
objects. The search query is constructed using the PostQuery.
This session defines views that offer differing behaviors for searching.
Posts may have a query record indicated by their respective query
record types. The query record is accessed via the PostQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPosts()
Tests if this user can perform
Post lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
PostQuery |
getPostQuery()
Gets a post query.
|
PostList |
getPostsByQuery(PostQuery payerQuery)
Gets a list of
Posts matching the given post query. |
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
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 canSearchPosts()
Post
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. PostQuery getPostQuery()
mandatory
- This method must be implemented. PostList getPostsByQuery(PostQuery payerQuery) throws OperationFailedException, PermissionDeniedException
Posts
matching the given post query.payerQuery
- the post query PostList
NullArgumentException
- postQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- postQuery
is not
of this servicemandatory
- This method must be implemented.