Package org.ametys.cms.search.systemprop

Class WorkflowStepSystemProperty

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.systemprop.AbstractSystemProperty

org.ametys.cms.search.systemprop.WorkflowStepSystemProperty

All Implemented Interfaces:

SystemProperty, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

WorkflowStepSystemProperty

public class WorkflowStepSystemProperty
extends AbstractSystemProperty

SystemProperty which represents the current workflow step ID of a content.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.model.SystemProperty

SystemProperty.EnumeratorDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowProvider	_workflowProvider	The workflow provider

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

_description, _i18nUtils, _id, _label, _pluginName, _resolver, _userHelper, _userManager

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.
SystemProperty.EnumeratorDefinition	getEnumeratorDefinition(Configuration configuration)	Get the definition of an enumerator.
Object	getJsonValue(Content content, boolean full)	Get the jsonified value
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.
SearchField	getSearchField()	Get the SearchField representing this system property.
MetadataType	getType()	Get the property type.
Object	getValue(Content content)	Get the typed raw value for this field in the given result content.
boolean	isMultiple()	Get the multiple status of the property.
boolean	isSortable()	Get if the property can be sorted on.
void	saxValue(ContentHandler handler, Content content)	SAX the value
void	service(ServiceManager manager)

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

_indexBooleanValue, _indexBooleanValues, _indexDateValue, _indexDateValues, _indexDoubleValue, _indexDoubleValues, _indexGeocodeValue, _indexLongValue, _indexLongValues, _indexStringValue, _indexStringValues, _indexUserValue, _indexUserValues, _parseI18nizableText, configure, getDescription, getId, getLabel, getSchemaDefinitions, getSortValue, index, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

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

getContentTypeId, getWidget, getWidgetParameters, isDisplayable, isFacetable, isSearchable

Field Detail

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

Constructor Detail

WorkflowStepSystemProperty

public WorkflowStepSystemProperty()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSystemProperty

Throws:

ServiceException

getType

public MetadataType getType()

Description copied from interface: SystemProperty

Get the property type.

Returns:

the property type.

isMultiple

public boolean isMultiple()

Description copied from interface: SystemProperty

Get the multiple status of the property.

Returns:

true if the property can have multiple values, false otherwise.

isSortable

public boolean isSortable()

Description copied from interface: SystemProperty

Get if the property can be sorted on.

Returns:

true if the property can be sorted on, false otherwise.

getQuery

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

Description copied from interface: SystemProperty

Get the Query associated to the given value.

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.

getSearchField

public SearchField getSearchField()

Description copied from interface: SystemProperty

Get the SearchField representing this system property.

Returns:

The search field representing this system property.

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(Content content)

Description copied from interface: SystemProperty

Get the typed raw value for this field in the given result content. The returned object depends on this field's type:
- MetadataType.STRING must return String or String[] if multiple
- MetadataType.DATE or MetadataType.DATETIME must return Date or Date[] if multiple
- MetadataType.LONG must return Long or Long[] if multiple
- MetadataType.DOUBLE must return Double or Double[] if multiple
- MetadataType.CONTENT must return String or String[] if multiple
- MetadataType.GEOCODE must return Map<String, Double>
- MetadataType.USER must return UserIdentity or UserIdentity[] if multiple
- MetadataType.MULTILINGUAL_STRING must return MultilingualString
Others types are not supported.

Parameters:

content - The result content

Returns:

The typed value, cast to the appropriate object according its type.

getJsonValue

public Object getJsonValue(Content content,
                           boolean full)

Description copied from interface: SystemProperty

Get the jsonified value

Parameters:

content - the result content

full - true to get full value.

Returns:

the content field value

saxValue

public void saxValue(ContentHandler handler,
                     Content content)
              throws SAXException

Description copied from interface: SystemProperty

SAX the value

Specified by:

saxValue in interface SystemProperty

Overrides:

saxValue in class AbstractSystemProperty

Parameters:

handler - The content handler to sax into

content - The content

Throws:

SAXException - If an error occurred while saxing

getEnumeratorDefinition

public SystemProperty.EnumeratorDefinition getEnumeratorDefinition(Configuration configuration)

Description copied from interface: SystemProperty

Get the definition of an enumerator.

Parameters:

configuration - The enumerator configuration.

Returns:

The enumerator definition or null if the property is not enumerated.