Package org.ametys.cms.search.systemprop

Class WorkflowStepSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<Long>

org.ametys.cms.model.properties.AbstractProperty<Long,IndexableAmetysObject>

org.ametys.cms.model.properties.AbstractStaticProperty<Long,IndexableAmetysObject>

org.ametys.cms.model.properties.AbstractIndexableStaticProperty<Long,Long,IndexableAmetysObject>

org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty<Long,Long,IndexableAmetysObject>

org.ametys.cms.search.systemprop.WorkflowStepSystemProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<Long,IndexableAmetysObject>, CriterionDefinitionAwareElementDefinition<Long,Long,IndexableAmetysObject>, IndexationAwareElementDefinition<Long,IndexableAmetysObject>, SystemProperty<Long,IndexableAmetysObject>, IndexationAwareSystemProperty<Long,IndexableAmetysObject>, ElementDefinition<Long>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

WorkflowStepSystemProperty

public class WorkflowStepSystemProperty
extends AbstractIndexableSystemProperty<Long,Long,IndexableAmetysObject>

SystemProperty which represents the current workflow step ID of an ametys object.

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowProvider	_workflowProvider	The workflow provider
static final String	SOLR_FIELD_NAME	Solr field name.
static final String	SYSTEM_PROPERTY_ID	System property identifier

Fields inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty

_criterionDefinitionHelper, _indexationAwareElementDefinitionHelper

Fields inherited from class org.ametys.cms.model.properties.AbstractStaticProperty

_context

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
WorkflowStepSystemProperty()

Method Summary

Modifier and Type	Method	Description
Integer	getColumnWidth()	Get the column width.
String	getConverter()	Get the property column converter.
Enumerator<Long>	getDefaultCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager)	Get the enumerator to use when rendering this item as a criterion, if no other enumerator is specified on criterion
Map<String,I18nizableText>	getDefaultCriterionWidgetParameters(Configuration configuration)	Get the widget parameters to use when rendering this item as a criterion If some other parameters are specified on criterion, all parameters are used If a parameter with the same name is specified on criterion, this parameter is used, not the default one
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
String	getRenderer()	Get the renderer.
String	getSolrFacetFieldName()	Retrieves the name of the element's solr facet field
String	getSolrFieldName()	Retrieves the name of the element's solr field
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(IndexableAmetysObject ametysObject)	Get the element's value
void	service(ServiceManager manager)
Object	valueToJSON(IndexableAmetysObject ametysObject, DataContext context)	Convert the property into a JSON object
void	valueToSAX(ContentHandler contentHandler, String tagName, IndexableAmetysObject ametysObject, DataContext context)	Generates SAX events for the property

Methods inherited from class org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty

_getNameConfigurationAttribute, getSchemaDefinitions, getSortValue, indexValue, parseStringArray

Methods inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty

getCriterionType, getCriterionTypeId

Methods inherited from class org.ametys.cms.model.properties.AbstractStaticProperty

_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize

Methods inherited from class org.ametys.cms.model.properties.AbstractProperty

getType, init, isEditable, setPluginInfo

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters, toSAX

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.ametys.cms.search.model.CriterionDefinitionAwareElementDefinition

convertQueryValue, getDefaultCriterionOperator, getDefaultCriterionWidget

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

Methods inherited from interface org.ametys.cms.search.model.IndexationAwareElementDefinition

getType, isFacetable, isSortable

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.cms.model.properties.Property

getType, init

Methods inherited from interface org.ametys.cms.search.model.SystemProperty

isDisplayable

Field Details

SYSTEM_PROPERTY_ID

public static final String SYSTEM_PROPERTY_ID

System property identifier

See Also:

• Constant Field Values

SOLR_FIELD_NAME

public static final String SOLR_FIELD_NAME

Solr field name.

See Also:

• Constant Field Values

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

Constructor Details

WorkflowStepSystemProperty

public WorkflowStepSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractIndexableStaticProperty<Long,Long,IndexableAmetysObject>

Throws:

ServiceException

getQuery

public Query getQuery(Object value,
 Query.Operator operator,
 String language,
 Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the Query associated to the given value.

Parameters:

value - the user-submitted value for this item.

operator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

The Query associated to the given value.

getSolrFieldName

public String getSolrFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr field

Returns:

the name of the element's solr field

getSolrSortFieldName

public String getSolrSortFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr sort field

Specified by:

getSolrSortFieldName in interface IndexationAwareElementDefinition<Long,IndexableAmetysObject>

Overrides:

getSolrSortFieldName in class AbstractIndexableStaticProperty<Long,Long,IndexableAmetysObject>

Returns:

the name of the element's solr sort field

getSolrFacetFieldName

public String getSolrFacetFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr facet field

Returns:

the name of the element's solr facet field

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Returns:

The column renderer.

getConverter

public String getConverter()

Description copied from interface: SystemProperty

Get the property column converter.

Returns:

The property column converter.

getColumnWidth

public Integer getColumnWidth()

Description copied from interface: SystemProperty

Get the column width.

Returns:

the default column width, can be null.

getValue

public Object getValue(IndexableAmetysObject ametysObject)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Parameters:

ametysObject - the ametysObject containing the element

Returns:

the values to index.

valueToJSON

public Object valueToJSON(IndexableAmetysObject ametysObject,
 DataContext context)

Description copied from interface: Property

Convert the property into a JSON object

Parameters:

ametysObject - the ametysObject containing the property to convert.

context - the context of the data to convert. Can not be null.

Returns:

The property as JSON

valueToSAX

public void valueToSAX(ContentHandler contentHandler,
 String tagName,
 IndexableAmetysObject ametysObject,
 DataContext context)
                throws SAXException

Description copied from interface: Property

Generates SAX events for the property

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

tagName - the tag name of the SAX event to generate.

ametysObject - the ametysObject containing the property to SAX.

context - the context of the data to SAX. Can not be null.

Throws:

SAXException - if an error occurs during the SAX events generation

getDefaultCriterionEnumerator

public Enumerator<Long> getDefaultCriterionEnumerator(Configuration configuration,
 ThreadSafeComponentManager<Enumerator> enumeratorManager)
                                               throws ConfigurationException

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the enumerator to use when rendering this item as a criterion, if no other enumerator is specified on criterion

Parameters:

configuration - The enumerator configuration.

enumeratorManager - ComponentManager for the criterion's Enumerator

Returns:

The enumerator or null if there is no default enumerator for the criterion

Throws:

ConfigurationException - If an error occurs while initializing the enumerator

getDefaultCriterionWidgetParameters

public Map<String,I18nizableText> getDefaultCriterionWidgetParameters(Configuration configuration)

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the widget parameters to use when rendering this item as a criterion If some other parameters are specified on criterion, all parameters are used If a parameter with the same name is specified on criterion, this parameter is used, not the default one

Parameters:

configuration - The widget parameters configuration

Returns:

The default widget parameters to use, or an empty Map if no specific widget parameters are necessary by default.

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<Long,IndexableAmetysObject>

Returns:

the id of the property's type