ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.ep.ux.content.model.search 

SearchParameters  - AS3 ADEP Content

Packagecom.adobe.ep.ux.content.model.search
Classpublic class SearchParameters
InheritanceSearchParameters Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Search Paramers used to tweak the Adobe Digital Enterprise Platform Experience Services - Content Repository search.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  cutPoints : String
Specify the level up to which objects are to be fetched and the properties are to be fetched.
SearchParameters
  includeContent : Boolean = false
This parameter specifies whether content is to be retrieved.
SearchParameters
  includeFile : Boolean = true
A flag that indicaates whether to include the file reference by default in the search results.
SearchParameters
  maxSize : int = 2.147483647E9
The maximum number of results to be returned.
SearchParameters
  performCaseSensitiveSearch : Boolean = false
A flaog that indicates whether to perform a case-sensitive search.
SearchParameters
  searchSubtypes : Boolean = true
A flag that indicates whether subclasses should be searched.
SearchParameters
  startOffset : int = 0
The starting offset from which results need to be returned.
SearchParameters
  systemSearch : Boolean = true
A flag that indicaates whether to fire search using system context.
SearchParameters
Public Methods
 MethodDefined By
  
Constructor.
SearchParameters
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

cutPoints

property
public var cutPoints:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Specify the level up to which objects are to be fetched and the properties are to be fetched.

includeContent

property 
public var includeContent:Boolean = false

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This parameter specifies whether content is to be retrieved.

includeFile

property 
public var includeFile:Boolean = true

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A flag that indicaates whether to include the file reference by default in the search results. Set the value to false if you do not want this behavior.

maxSize

property 
public var maxSize:int = 2.147483647E9

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The maximum number of results to be returned.

performCaseSensitiveSearch

property 
public var performCaseSensitiveSearch:Boolean = false

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A flaog that indicates whether to perform a case-sensitive search.

searchSubtypes

property 
public var searchSubtypes:Boolean = true

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A flag that indicates whether subclasses should be searched.

startOffset

property 
public var startOffset:int = 0

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The starting offset from which results need to be returned.

systemSearch

property 
public var systemSearch:Boolean = true

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A flag that indicaates whether to fire search using system context. If set to false then search would be fired based on User Context. Default value is true.

Constructor Detail

SearchParameters

()Constructor
public function SearchParameters()

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Constructor.