Packagecom.adobe.bridge
Classpublic class SearchSpecification
InheritanceSearchSpecification Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Returned from a selection in the Find dialog. Encapsulates a specific search among member nodes of a target container node. The object contains a set of conditions to be met in order for a node to match, and instructions for how to return matching nodes.Adobe Bridge creates this object from user selections in the Find dialog. For a search that involves handled nodes, Adobe Bridge passes the search specification to the handler's getBridgeUriForSearch() method.



Public Properties
 PropertyDefined By
  conditionList : Array
A collection of SearchCondition objects to use for this search.
SearchSpecification
  conjunction : String
The search conjunction, and or or, as selected in the Find dialog.
SearchSpecification
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  maximumResults : Number
The maximum number of result nodes to return from the search.
SearchSpecification
  quickSearchItem : String
SearchSpecification
  quickSearchValue : String
SearchSpecification
  rankField : String
The name of a Rank object, as specified for a SearchDefinition object.
SearchSpecification
  rankOrdering : String
The ordering style, one of ascending (the default) or descending.
SearchSpecification
  scopeSpecifiers : Array
One or more Scope object name strings, as specified for a SearchDefinition object.
SearchSpecification
Public Methods
 MethodDefined By
  
SearchSpecification(conditionList:Array = null, conjunction:String = null, maximumResults:Number, rankOrdering:String = null, rankField:String = null, scopeSpecifiers:Array = null, quickSearchItem:String = null, quickSearchValue:String = null)
SearchSpecification
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
  
createWithArgs(args:Array):void
[override]
SearchSpecification
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
conditionListproperty
conditionList:Array

Since : CS5

A collection of SearchCondition objects to use for this search.


Implementation
    public function get conditionList():Array
    public function set conditionList(value:Array):void
conjunctionproperty 
conjunction:String

Since : CS5

The search conjunction, and or or, as selected in the Find dialog.


Implementation
    public function get conjunction():String
    public function set conjunction(value:String):void
maximumResultsproperty 
maximumResults:Number

Since : CS5

The maximum number of result nodes to return from the search.


Implementation
    public function get maximumResults():Number
    public function set maximumResults(value:Number):void
quickSearchItemproperty 
quickSearchItem:String

Since : CS5


Implementation
    public function get quickSearchItem():String
    public function set quickSearchItem(value:String):void
quickSearchValueproperty 
quickSearchValue:String

Since : CS5


Implementation
    public function get quickSearchValue():String
    public function set quickSearchValue(value:String):void
rankFieldproperty 
rankField:String

Since : CS5

The name of a Rank object, as specified for a SearchDefinition object.


Implementation
    public function get rankField():String
    public function set rankField(value:String):void
rankOrderingproperty 
rankOrdering:String

Since : CS5

The ordering style, one of ascending (the default) or descending.


Implementation
    public function get rankOrdering():String
    public function set rankOrdering(value:String):void
scopeSpecifiersproperty 
scopeSpecifiers:Array

Since : CS5

One or more Scope object name strings, as specified for a SearchDefinition object.


Implementation
    public function get scopeSpecifiers():Array
    public function set scopeSpecifiers(value:Array):void
Constructor Detail
SearchSpecification()Constructor
public function SearchSpecification(conditionList:Array = null, conjunction:String = null, maximumResults:Number, rankOrdering:String = null, rankField:String = null, scopeSpecifiers:Array = null, quickSearchItem:String = null, quickSearchValue:String = null)

Since : CS5

Parameters
conditionList:Array (default = null) — (Array)
 
conjunction:String (default = null) — (String)
 
maximumResults:Number (default = NaN) — (Number)
 
rankOrdering:String (default = null) — (String)
 
rankField:String (default = null) — (String)
 
scopeSpecifiers:Array (default = null) — (Array)
 
quickSearchItem:String (default = null) — (String)
 
quickSearchValue:String (default = null) — (String)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array