ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.assetmanager.client.model.cms 

SearchParameters  - AS3 Asset Manager
Packagecom.adobe.livecycle.assetmanager.client.model.cms
Classpublic class SearchParameters
InheritanceSearchParameters Inheritance Object
Deprecated: Deprecated

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Provides search parameters that can be used to modify the content management system search.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  includeContent : Boolean = false
Specifies whether to retrieve content or not.
SearchParameters
  maxSize : int = 2.147483647E9
Specifies the maximum number of results to return.
SearchParameters
  searchAllVersions : Boolean = false
Specifies whether to return the non-latest versions in search results.
SearchParameters
  searchDepth : String = "NO_CHILDREN"
Specifies the depth of the search.
SearchParameters
  searchSubTypes : Boolean = false
Specifies whether subclasses are also searched.
SearchParameters
  startOffset : int = 0
Specifies the value used to offset the start of the search.
SearchParameters
  systemSearch : Boolean = false
Specifies whether the search also returns system assets.
SearchParameters
Public Methods
 MethodDefined By
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  ALL_CHILDREN : String = "ALL_CHILDREN"
[static] Specifies to fetch all children.
SearchParameters
  IMMEDIATE_CHILDREN : String = "IMMEDIATE_CHILDREN"
[static] Specifies to fetch first-level children only.
SearchParameters
  NO_CHILDREN : String = "NO_CHILDREN"
[static] Specifies to fetch no children.
SearchParameters
Property Detail

includeContent

property
public var includeContent:Boolean = false

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether to retrieve content or not.

maxSize

property 
public var maxSize:int = 2.147483647E9

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies the maximum number of results to return.

searchAllVersions

property 
public var searchAllVersions:Boolean = false

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether to return the non-latest versions in search results. Used only for searchRepositoryObjects.

searchDepth

property 
public var searchDepth:String = "NO_CHILDREN"

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies the depth of the search. Valid values are NO_CHILDREN, IMMEDIATE_CHILDREN, and ALL_CHILDREN.

searchSubTypes

property 
public var searchSubTypes:Boolean = false

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether subclasses are also searched.

startOffset

property 
public var startOffset:int = 0

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies the value used to offset the start of the search.

systemSearch

property 
public var systemSearch:Boolean = false

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether the search also returns system assets. For example, system data dictionaries.

Constant Detail

ALL_CHILDREN

Constant
public static const ALL_CHILDREN:String = "ALL_CHILDREN"

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies to fetch all children.

IMMEDIATE_CHILDREN

Constant 
public static const IMMEDIATE_CHILDREN:String = "IMMEDIATE_CHILDREN"

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies to fetch first-level children only.

NO_CHILDREN

Constant 
public static const NO_CHILDREN:String = "NO_CHILDREN"

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Specifies to fetch no children.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy