org.alfresco.repo.jscript

Class ScriptFacetResult

java.lang.Object

org.alfresco.repo.jscript.ScriptFacetResult

All Implemented Interfaces:

Serializable

public class ScriptFacetResult
extends Object
implements Serializable

Scriptable facet. Specific for use by Search script as part of the object model.

Author:

Jamal Kaabi-Mofrad

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScriptFacetResult(String facetValue, String facetLabel, int facetLabelIndex, int hits)

Method Summary

Modifier and Type	Method and Description
String	getFacetLabel()
int	getFacetLabelIndex()
String	getFacetValue()
int	getHits()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptFacetResult

public ScriptFacetResult(String facetValue,
                         String facetLabel,
                         int facetLabelIndex,
                         int hits)

Parameters:

facetValue - the facet value. e.g. the content creator's userID

facetLabel - the display name of the facetValue. e.g. jdoe => John Doe

facetLabelIndex - the label index to be used for sorting (Optional).The default value is -1

hits - the number of hits

Method Detail

getFacetValue

public String getFacetValue()

Returns:

the facetValue

getFacetLabel

public String getFacetLabel()

Returns:

the facetLabel

getFacetLabelIndex

public int getFacetLabelIndex()

Returns:

the facetLabelIndex

getHits

public int getHits()

Returns:

the hits