public interface ItemQuerySession extends OsidSession
This session provides methods for searching among Item
objects. The search query is constructed using the ItemQuery.
This session defines views that offer differing behaviors for searching.
items may have a query record indicated by their respective record
types. The query record is accessed via the ItemQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchItems()
Tests if this user can perform
Item lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
ItemQuery |
getItemQuery()
Gets an item query.
|
ItemList |
getItemsByQuery(ItemQuery itemQuery)
Gets a list of
Items matching the given item 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 canSearchItems()
Item
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. ItemQuery getItemQuery()
mandatory
- This method must be implemented. ItemList getItemsByQuery(ItemQuery itemQuery) throws OperationFailedException, PermissionDeniedException
Items
matching the given item query.itemQuery
- the item query ItemList
NullArgumentException
- itemQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- itemQuery
is not
of this servicemandatory
- This method must be implemented.