Class awExcludedKeywordSearchParameter

Description

A SearchParameter for {@code KEYWORD} IdeaTypes that

specifies Keywords that should be excluded from the results.<p> The KeywordMatchType associated with these keywords is used to provide various filtering strategies. For example, the excluded keyword "sony player" will exclude ideas from the resulting ideas as described by the table below. <table border="1"> <tr style="font-weight: bold;"> <th>Idea</th> <th>{@code BROAD}</th> <th>{@code PHRASE}</th> <th>{@code EXACT}</th> </tr> <tr> <td>sony player</td> <td>Exclude</td> <td>Exclude</td> <td>Exclude</td> </tr> <tr> <td>blu-ray sony player</td> <td>Exclude</td> <td>Exclude</td> <td>Include</td> </tr> <tr> <td>sony dvd player</td> <td>Exclude</td> <td>Include</td> <td>Include</td> </tr> <tr> <td>sony dvd</td> <td>Include</td> <td>Include</td> <td>Include</td> </tr> </table> <p>This element is supported by following IdeaTypes: KEYWORD. <p>This element is supported by following RequestTypes: IDEAS, STATS.

Located in /classes/o/ExcludedKeywordSearchParameter.php

awComplexObject
   |
   --awSearchParameter
      |
      --awExcludedKeywordSearchParameter
Variable Summary
 awKeyword[] $keywords
Method Summary
 void getRow ()
Variables
awKeyword[] $keywords

A List of Keywords to be excluded from the search results.

<span class="constraint ContentsDistinct">This field must contain distinct elements.</span> <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span> <span class="constraint NotEmpty">This field must contain at least one element.</span> <span class="constraint Required">This field is required and should not be {@code null}.</span>

mixed $_checkFields = array(
'keywords' => array(
'objName' => 'awKeyword',
'type' => 'array'
),)
  • access: public

Redefinition of:
awComplexObject::$_checkFields

Inherited Variables

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row
Methods

Documentation generated on Fri, 23 Mar 2012 13:43:58 +0200 by phpDocumentor 1.4.3