public interface WorkQuerySession extends OsidSession
This session provides methods for searching among Work
objects. The search query is constructed using the WorkQuery.
This session defines views that offer differing behaviors for searching.
Works may have a query record indicated by their respective record
types. The query record is accessed via the WorkQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchWorks()
Tests if this user can perform
Work lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
WorkQuery |
getWorkQuery()
Gets a work query.
|
WorkList |
getWorksByQuery(WorkQuery workQuery)
Gets a list of
Works matching the given work query. |
void |
useFederatedOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedOfficeView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchWorks()
Work
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 useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. WorkQuery getWorkQuery()
mandatory
- This method must be implemented. WorkList getWorksByQuery(WorkQuery workQuery) throws OperationFailedException, PermissionDeniedException
Works
matching the given work query.workQuery
- the work query WorkList
NullArgumentException
- workQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- workQuery
is not
of this servicemandatory
- This method must be implemented.