Package org.ametys.cms.search.systemprop

Class WorkflowNameSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<T,X>

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

org.ametys.cms.search.systemprop.WorkflowNameSystemProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<String,ModelAwareDataAwareAmetysObject>, SystemProperty<String,ModelAwareDataAwareAmetysObject>, ElementDefinition<String>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Serviceable

public class WorkflowNameSystemProperty
extends AbstractSystemProperty<String,ModelAwareDataAwareAmetysObject>

SystemProperty which represents the current workflow name of an ametys object.

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

_i18nUtils, _manager, _resolver, _userHelper, _userManager

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

_availableTypesExtensionPoint

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

_logger

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

__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
WorkflowNameSystemProperty()

Method Summary

Modifier and Type	Method	Description
protected String	_getTypeId()	Retrieves the id of the property's type
Enumerator<String>	getCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager)	Get the enumerator to use when rendering this 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.
SearchField	getSearchField()	Get the SearchField representing this system property.
Object	getValue(ModelAwareDataAwareAmetysObject ametysObject)	Get the property's value
boolean	isMultiple()	Test if the element is multiple.
boolean	isSortable()	Get if the property can be sorted on.
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, getSchemaDefinitions, getSortValue, indexValue, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray

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

_parseI18nizableText, configure, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

_getDefaultValues, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, 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, 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.runtime.model.ElementDefinition

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

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

getCriterionWidget, getCriterionWidgetParameters, getType, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint

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

getColumnWidth, getConverter, isDisplayable, isFacetable, isSearchable

Field Details

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

Constructor Details

WorkflowNameSystemProperty

public WorkflowNameSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSystemProperty<String,ModelAwareDataAwareAmetysObject>

Throws:

ServiceException

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<String>

Overrides:

isMultiple in class DefaultElementDefinition<String>

Returns:

true if the metadata is multiple.

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.

getValue

public Object getValue(ModelAwareDataAwareAmetysObject ametysObject)

Description copied from interface: Property

Get the property's value

Parameters:

ametysObject - the ametysObject containing the property

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

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

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

getCriterionEnumerator

public Enumerator<String> getCriterionEnumerator(Configuration configuration,
 ThreadSafeComponentManager<Enumerator> enumeratorManager)
                                          throws ConfigurationException

Description copied from interface: ElementDefinition

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

Parameters:

configuration - The enumerator configuration.

enumeratorManager - ComponentManager for the criterion's Enumerator

Returns:

The enumerator or null if the element'critérion is not enumerated.

Throws:

ConfigurationException - If an error occurs while initializing the enumerator

_getTypeId

protected String _getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

_getTypeId in class AbstractProperty<String,ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type