Docs For Class FieldValueSearch

Class FieldValueSearch

Description

Searches for only Records that contain a certain field=value pair.

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

SearchCriteria
   |
   --FieldValueSearch

Variable Summary

mixed $_comparison

mixed $_label

mixed $_schemaID

mixed $_value

Method Summary

void FieldValueSearch (string $schemaID, string $label, ref $value, [optional $comparisonType = SEARCH_TYPE_EQUALS])

void postProcess (mixed $ids)

void returnSearchString ()

Variables

mixed $_comparison (line 20)

mixed $_label (line 18)

mixed $_schemaID (line 17)

mixed $_value (line 19)

Methods

Constructor FieldValueSearch (line 30)

The constructor.

void FieldValueSearch (string $schemaID, string $label, ref $value, [optional $comparisonType = SEARCH_TYPE_EQUALS])

string $schemaID: The ID that references the Schema to apply this search to.
string $label: The specific field within that Schema to check.
ref $value: object $value An SObject object which holds the value to search for.
optional $comparisonType: int $comparisonType The comparison type to use (equals, contains, less than, etc.) See the SEARCH_TYPE_* constants. Defaults to SEARCH_TYPE_EQUALS

postProcess (line 64)

void postProcess (mixed $ids)

Redefinition of:

SearchCriteria::postProcess(): Returns an array of new IDs, giving the criteria the opportunity to do post-processing if that is desired. If no post-processing is to be done, it should return what is passed.

returnSearchString (line 37)

void returnSearchString ()

Redefinition of:

SearchCriteria::returnSearchString(): Returns a string with what will end up part of an SQL query in the WHERE clause.

Inherited From SearchCriteria

SearchCriteria::postProcess()
SearchCriteria::returnSearchString()

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