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,ModelAwareDataAwareAmetysObject>

org.ametys.cms.search.systemprop.AbstractSystemProperty<Long,ModelAwareDataAwareAmetysObject>

org.ametys.cms.search.systemprop.WorkflowStepSystemProperty

All Implemented Interfaces:

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

Direct Known Subclasses:

WorkflowStepSystemProperty

public class WorkflowStepSystemProperty
extends AbstractSystemProperty<Long,ModelAwareDataAwareAmetysObject>
implements CriterionDefinitionAwareElementDefinition<Long>, IndexationAwareSystemProperty<Long,ModelAwareDataAwareAmetysObject>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
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.AbstractProperty

_availableTypesExtensionPoint, _context, _manager

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<String>	getDefaultCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager)	Get the enumerator to use when rendering this property as a criterion
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
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(ModelAwareDataAwareAmetysObject ametysObject)	Get the element's value
void	service(ServiceManager manager)
Object	valueToJSON(ModelAwareDataAwareAmetysObject ametysObject, DataContext context)	Convert the property into a JSON object
void	valueToSAX(ContentHandler contentHandler, ModelAwareDataAwareAmetysObject ametysObject, DataContext context)	Generates SAX events for the property

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

_getNameConfigurationAttribute, parseStringArray

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

_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

_defaultValueToJSON, _getDefaultValues, _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, getDefaultCriterionWidgetParameters, getType

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

getSortValue, getType, isFacetable, isSortable

Methods inherited from interface org.ametys.cms.search.systemprop.IndexationAwareSystemProperty

getSchemaDefinitions, indexValue

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, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint

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

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition 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 AbstractProperty<Long,ModelAwareDataAwareAmetysObject>

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.

Specified by:

getQuery in interface CriterionDefinitionAwareElementDefinition<Long>

Parameters:

value - the user-submitted value for this property.

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

Specified by:

getSolrFieldName in interface IndexationAwareElementDefinition<Long,ModelAwareDataAwareAmetysObject>

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,ModelAwareDataAwareAmetysObject>

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

Specified by:

getSolrFacetFieldName in interface IndexationAwareElementDefinition<Long,ModelAwareDataAwareAmetysObject>

Returns:

the name of the element's solr facet field

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Specified by:

getRenderer in interface SystemProperty<Long,ModelAwareDataAwareAmetysObject>

Returns:

The column renderer.

getConverter

public String getConverter()

Description copied from interface: SystemProperty

Get the property column converter.

Specified by:

getConverter in interface SystemProperty<Long,ModelAwareDataAwareAmetysObject>

Returns:

The property column converter.

getColumnWidth

public Integer getColumnWidth()

Description copied from interface: SystemProperty

Get the column width.

Specified by:

getColumnWidth in interface SystemProperty<Long,ModelAwareDataAwareAmetysObject>

Returns:

the default column width, can be null.

getValue

public Object getValue(ModelAwareDataAwareAmetysObject ametysObject)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Specified by:

getValue in interface IndexationAwareElementDefinition<Long,ModelAwareDataAwareAmetysObject>

Specified by:

getValue in interface Property<Long,ModelAwareDataAwareAmetysObject>

Parameters:

ametysObject - the ametysObject containing the element

Returns:

the values to index.

valueToJSON

public Object valueToJSON(ModelAwareDataAwareAmetysObject ametysObject,
 DataContext context)

Description copied from interface: Property

Convert the property into a JSON object

Specified by:

valueToJSON in interface Property<Long,ModelAwareDataAwareAmetysObject>

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,
 ModelAwareDataAwareAmetysObject ametysObject,
 DataContext context)
                throws SAXException

Description copied from interface: Property

Generates SAX events for the property

Specified by:

valueToSAX in interface Property<Long,ModelAwareDataAwareAmetysObject>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

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<String> getDefaultCriterionEnumerator(Configuration configuration,
 ThreadSafeComponentManager<Enumerator> enumeratorManager)
                                                 throws ConfigurationException

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the enumerator to use when rendering this property as a criterion

Specified by:

getDefaultCriterionEnumerator in interface CriterionDefinitionAwareElementDefinition<Long>

Parameters:

configuration - The enumerator configuration.

enumeratorManager - ComponentManager for the criterion's Enumerator

Returns:

The enumerator or null if the property's criterion is not enumerated.

Throws:

ConfigurationException - If an error occurs while initializing the enumerator

getDefaultCriterionType

public IndexableElementType getDefaultCriterionType()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the type to use when rendering the element as a criterion

Specified by:

getDefaultCriterionType in interface CriterionDefinitionAwareElementDefinition<Long>

Returns:

the type to use for a criterion

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<Long,ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type