com.appiancorp.common.query

Class TypedValueFacet

java.lang.Object

com.appiancorp.common.query.Facet<TypedValue>

com.appiancorp.common.query.TypedValueFacet

All Implemented Interfaces:

com.appiancorp.common.query.ReadOnlyFacet<TypedValue>

@GwtCompatible
public final class TypedValueFacet
extends Facet<TypedValue>

This class holds the metadata for a facet and its options. For example, a Car record could have a Color facet with the options Black, White, Silver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypedValueFacet.TypedValueFacetBuilder A builder that will construct a TypedValueFacet with the correct parameters

Field Summary

Fields inherited from class com.appiancorp.common.query.Facet

DEFAULT_OPTION, LOCAL_PART, QNAME, VISIBLE_BY_DEFAULT, XML_ROOT_ELEMENT

Constructor Summary

Constructors

Constructor and Description
TypedValueFacet(java.lang.Long id, java.lang.String name, boolean isVisible, java.lang.String defaultOption, java.util.List<FacetOption<TypedValue>> options, int numOmittedOptions, int omittedOptionsDataCount, boolean isExclusiveOptions, boolean allowMultipleSelections, java.lang.String facetType, java.lang.Object facetData, java.lang.String sourceRef)
TypedValueFacet(java.lang.String name, boolean isVisible, java.lang.String defaultOption, java.util.List<FacetOption<TypedValue>> options, int numOmittedOptions, int omittedOptionsDataCount, boolean isExclusiveOptions) Constructs a new selection/dropdown facet.
TypedValueFacet(java.lang.String name, boolean isVisible, java.lang.String defaultOption, java.util.List<FacetOption<TypedValue>> options, int numOmittedOptions, int omittedOptionsDataCount, boolean isExclusiveOptions, boolean allowMultipleSelections, java.lang.String facetType, java.lang.Object facetData, java.lang.String sourceRef)
TypedValueFacet(java.lang.String name, boolean isVisible, java.lang.String facetType, java.lang.Object facetData, java.lang.String sourceRef) Constructs a new date range facet (Assuming the DATE_RANGE "facetType" is passed in)
TypedValueFacet(com.appiancorp.type.cdt.UserDtoFacetOptionGroup dtoFacet)

Method Summary

Modifier and Type	Method and Description
boolean	getAllowMultipleSelections()
java.lang.Object	getFacetData()
java.lang.Long	getId()
java.util.List<FacetOption<TypedValue>>	getOptions()
protected void	setAllowMultipleSelections(boolean allowMultipleSelections)
protected void	setFacetData(java.lang.Object facetData)
protected void	setOptions(java.util.List<FacetOption<TypedValue>> options) Sets the options for this facet.

Methods inherited from class com.appiancorp.common.query.Facet

equalDataCheck, equals, findOptionById, findOptionById, findOptionByIdReadOnly, findOptionByIdReadOnly, getAppliedOptions, getDefaultOption, getFacetType, getName, getNumOmittedOptions, getOmittedOptionsDataCount, getOptionsReadOnly, getSourceRef, getTotalNumOptions, hashCode, isExclusiveOptions, isVisible, multilineToString, setAppliedOptions, setAppliedOptions, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypedValueFacet

public TypedValueFacet(java.lang.String name,
                       boolean isVisible,
                       java.lang.String defaultOption,
                       java.util.List<FacetOption<TypedValue>> options,
                       int numOmittedOptions,
                       int omittedOptionsDataCount,
                       boolean isExclusiveOptions)

Constructs a new selection/dropdown facet.

Parameters:

name - The name of the facet.

options - The list of options for this facet.

defaultOption - The label name of the option to be applied

isVisible - is the facet visible at run time to the user.

numOmittedOptions - The number of additional options that are available, but are not included in the provided list of options.

omittedOptionsDataCount - The number of objects that contain data matched by the omitted options. This allows the UI to present the generic option "Other" along with a count.

isExclusiveOptions - Whether this facet's options are exclusive or not. See Facet.isExclusiveOptions().

TypedValueFacet

public TypedValueFacet(java.lang.String name,
                       boolean isVisible,
                       java.lang.String facetType,
                       java.lang.Object facetData,
                       java.lang.String sourceRef)

Constructs a new date range facet (Assuming the DATE_RANGE "facetType" is passed in)

Parameters:

name - The name of the facet

isVisible - is the facet visible at run time

facetType - from FieldCfg$FacetType enum (Right now we only know how to process DATE_RANGE)

facetData - data fields specific to this type of facet

sourceRef - name of the field (record list is bring filtered on)

TypedValueFacet

public TypedValueFacet(java.lang.String name,
                       boolean isVisible,
                       java.lang.String defaultOption,
                       java.util.List<FacetOption<TypedValue>> options,
                       int numOmittedOptions,
                       int omittedOptionsDataCount,
                       boolean isExclusiveOptions,
                       boolean allowMultipleSelections,
                       java.lang.String facetType,
                       java.lang.Object facetData,
                       java.lang.String sourceRef)

TypedValueFacet

public TypedValueFacet(java.lang.Long id,
                       java.lang.String name,
                       boolean isVisible,
                       java.lang.String defaultOption,
                       java.util.List<FacetOption<TypedValue>> options,
                       int numOmittedOptions,
                       int omittedOptionsDataCount,
                       boolean isExclusiveOptions,
                       boolean allowMultipleSelections,
                       java.lang.String facetType,
                       java.lang.Object facetData,
                       java.lang.String sourceRef)

TypedValueFacet

public TypedValueFacet(com.appiancorp.type.cdt.UserDtoFacetOptionGroup dtoFacet)

Method Detail

getId

public java.lang.Long getId()

getOptions

public java.util.List<FacetOption<TypedValue>> getOptions()

Specified by:

getOptions in class Facet<TypedValue>

Returns:

The options of this facet.

setOptions

protected void setOptions(java.util.List<FacetOption<TypedValue>> options)

Description copied from class: Facet

Sets the options for this facet.

Specified by:

setOptions in class Facet<TypedValue>

Parameters:

options - the list of options

getFacetData

public java.lang.Object getFacetData()

setFacetData

protected void setFacetData(java.lang.Object facetData)

getAllowMultipleSelections

public boolean getAllowMultipleSelections()

setAllowMultipleSelections

protected void setAllowMultipleSelections(boolean allowMultipleSelections)