public interface ProjectQuerySession extends OsidSession
This session provides methods for searching Project
objects. The search query is constructed using the ProjectQuery.
The project record Type
also specifies the record
for the project query.
Projects may have a query record indicated by their respective record
types. The query record is accessed via the ProjectQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchProjects()
Tests if this user can perform
Project searches. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
ProjectQuery |
getProjectQuery()
Gets a project query.
|
ProjectList |
getProjectsByQuery(ProjectQuery projectQuery)
Gets a list of
Projects matching the given project
query. |
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchProjects()
Project
searches. 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 opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. ProjectQuery getProjectQuery()
mandatory
- This method must be implemented. ProjectList getProjectsByQuery(ProjectQuery projectQuery) throws OperationFailedException, PermissionDeniedException
Projects
matching the given project
query.projectQuery
- the project query ProjectList
NullArgumentException
- projectQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ProjectQuery
is
not of this servicemandatory
- This method must be implemented.