Interface AgentQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AgentSearchSession
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.

  • federated agency view: searches include agents in agencies of which this agency is a ancestor in the agency hierarchy
  • isolated agency view: searches are restricted to agents in this agency

Agents may have an agent query record indicated by their respective agent record types. The agent query record is accessed via the AgentQuery .

  • Method Details

    • getAgencyId

      Id getAgencyId()
      Gets the Agency Id associated with this session.
      Returns:
      the Agency Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getAgency

      Agency getAgency() throws OperationFailedException, PermissionDeniedException
      Gets the Agency associated with this session.
      Returns:
      the Agency associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchAgents

      boolean canSearchAgents()
      Tests if this user can perform 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.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedAgencyView

      void useFederatedAgencyView()
      Federates the view for methods in this session. A federated view will include agents in agencies which are children of this agency in the agency hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAgencyView

      void useIsolatedAgencyView()
      Isolates the view for methods in this session. An isolated view restricts searches to this agency only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAgentQuery

      AgentQuery getAgentQuery()
      Gets an agent query.
      Returns:
      the agent query
      Compliance:
      mandatory - This method must be implemented.

    • getAgentsByQuery

      AgentList getAgentsByQuery(AgentQuery agentQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Agents matching the given agent query.
      Parameters:
      agentQuery - the agent query
      Returns:
      the returned AgentList
      Throws:
      NullArgumentException - agentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - agentQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.