Docs For Class AgentSearchInterface

Description

The AgentSearch interface defines methods for searching for agents. This is used by the AgentManager for searching for agents.

version: $Id: AgentSearch.interface.php,v 1.6 2007/09/04 20:25:36 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Direct descendents

Class	Description
AncestorGroupSearch	The AgentSearch interface defines methods for searching for agents. This is used by the AgentManager for searching for agents.
ClassTokenSearch	The AgentSearch interface defines methods for searching for agents. This is used by the AgentManager for searching for agents.
RootGroupSearch	The AgentSearch interface defines methods for searching for agents. This is used by the AgentManager for searching for agents.
TokenSearch	The AgentSearch interface defines methods for searching for agents. This is used by the AgentManager for searching for agents.

Method Summary

object AgentIterator getAgentsBySearch (mixed $searchCriteria, object Type $agentSearchType)

object AgentIterator getGroupsBySearch (mixed $searchCriteria, object Type $groupSearchType)

Methods

getAgentsBySearch (line 28)

Get all the Agents with the specified search criteria and search Type.

This method is defined in v.2 of the OSIDs.

object AgentIterator getAgentsBySearch (mixed $searchCriteria, object Type $agentSearchType)

Redefined in descendants as:

AncestorGroupSearch::getAgentsBySearch() : Get all the Agents with the specified search criteria and search Type.
ClassTokenSearch::getAgentsBySearch() : Get all the Agents with the specified search criteria and search Type.
RootGroupSearch::getAgentsBySearch() : Get all the Agents with the specified search criteria and search Type.
TokenSearch::getAgentsBySearch() : Get all the Agents with the specified search criteria and search Type.

getGroupsBySearch (line 43)

Get all the Groups with the specified search criteria and search Type.

This method is defined in v.2 of the OSIDs.

object AgentIterator getGroupsBySearch (mixed $searchCriteria, object Type $groupSearchType)

Redefined in descendants as:

AncestorGroupSearch::getGroupsBySearch() : Get all the Groups with the specified search criteria and search Type.
ClassTokenSearch::getGroupsBySearch() : Get all the Groups with the specified search criteria and search Type.
RootGroupSearch::getGroupsBySearch() : Get all the Groups with the specified search criteria and search Type.
TokenSearch::getGroupsBySearch() : Get all the Groups with the specified search criteria and search Type.