public interface AgentQuerySession extends OsidSession
This session provides methods for searching Agents.
The
search query is constructed using the AgentQuery.
The agent
record Type
also specifies the record for the agent query.
This session defines views that offer differing behaviors for searching.
Agents may have an agent query record indicated by their respective
agent record types. The agent query record is accessed via the
AgentQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAgents()
Tests if this user can perform
Agent searches. |
Agency |
getAgency()
Gets the
Agency associated with this session. |
Id |
getAgencyId()
Gets the
Agency Id associated with this
session. |
AgentQuery |
getAgentQuery()
Gets an agent query.
|
AgentList |
getAgentsByQuery(AgentQuery agentQuery)
Gets a list of
Agents matching the given agent query. |
void |
useFederatedAgencyView()
Federates the view for methods in this session.
|
void |
useIsolatedAgencyView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAgencyId()
Agency
Id
associated with this
session. Agency Id
associated with this sessionmandatory
- This method must be implemented. Agency getAgency() throws OperationFailedException, PermissionDeniedException
Agency
associated with this session. Agency
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAgents()
Agent
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 useFederatedAgencyView()
mandatory
- This method is must be implemented. void useIsolatedAgencyView()
mandatory
- This method is must be implemented. AgentQuery getAgentQuery()
mandatory
- This method must be implemented. AgentList getAgentsByQuery(AgentQuery agentQuery) throws OperationFailedException, PermissionDeniedException
Agents
matching the given agent query.agentQuery
- the agent query AgentList
NullArgumentException
- agentQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- agentQuery
is not
of this servicemandatory
- This method must be implemented.