public interface PostEntryQuerySession extends OsidSession
This session provides methods for searching among PostEntry
objects. The search query is constructed using the
PostEntryQuery.
This session defines views that offer differing behaviors for searching.
PostPost Entries may have a query record indicated by their respective
record types. The query record is accessed via the PostEntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPostEntries()
Tests if this user can perform
PostEntry lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
PostEntryList |
getPostEntriesByQuery(PostEntryQuery postEntryQuery)
Gets a list of
PostEntries matching the given post
entry query. |
PostEntryQuery |
getPostEntryQuery()
Gets a post entry 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 canSearchPostEntries()
PostEntry
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. PostEntryQuery getPostEntryQuery()
mandatory
- This method must be implemented. PostEntryList getPostEntriesByQuery(PostEntryQuery postEntryQuery) throws OperationFailedException, PermissionDeniedException
PostEntries
matching the given post
entry query.postEntryQuery
- the post entry query PostEntryList
NullArgumentException
- postEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- postEntryQuery
is
not of this servicemandatory
- This method must be implemented.