Docs For Class AncestorGroupSearch

Class AncestorGroupSearch

Description

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

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

AgentSearchInterface
   |
   --AncestorGroupSearch

Variable Summary

object $_hierarchy

Method Summary

object AncestorGroupSearch (mixed $hierarchy, integer $dbIndex)

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

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

Variables

object $_hierarchy (line 25)

Methods

Constructor AncestorGroupSearch (line 34)

Constructor

object AncestorGroupSearch (mixed $hierarchy, integer $dbIndex)

getAgentsBySearch (line 51)

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)

Redefinition of:

AgentSearchInterface::getAgentsBySearch(): Get all the Agents with the specified search criteria and search Type.

getGroupsBySearch (line 70)

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)

Redefinition of:

AgentSearchInterface::getGroupsBySearch(): Get all the Groups with the specified search criteria and search Type.

AgentSearchInterface::getAgentsBySearch()
AgentSearchInterface::getGroupsBySearch()

Documentation generated on Wed, 19 Sep 2007 10:21:29 -0400 by phpDocumentor 1.3.0RC3