Package org.ametys.cms.search.systemprop
Class WorkflowNameSystemProperty
java.lang.Object
org.ametys.runtime.model.AbstractModelItem
org.ametys.runtime.model.DefaultElementDefinition<String>
org.ametys.cms.model.properties.AbstractProperty<String,ModelAwareDataAwareAmetysObject>
org.ametys.cms.model.properties.AbstractStaticProperty<String,ModelAwareDataAwareAmetysObject>
org.ametys.cms.model.properties.AbstractIndexableStaticProperty<String,String,ModelAwareDataAwareAmetysObject>
org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty<String,String,ModelAwareDataAwareAmetysObject>
org.ametys.cms.search.systemprop.WorkflowNameSystemProperty
- All Implemented Interfaces:
Comparable<ModelItem>
,Property<String,
,ModelAwareDataAwareAmetysObject> CriterionDefinitionAwareElementDefinition<String,
,String, ModelAwareDataAwareAmetysObject> IndexationAwareElementDefinition<String,
,ModelAwareDataAwareAmetysObject> SystemProperty<String,
,ModelAwareDataAwareAmetysObject> IndexationAwareSystemProperty<String,
,ModelAwareDataAwareAmetysObject> ElementDefinition<String>
,ModelItem
,PluginAware
,Labelable
,ModifiableLabelable
,Configurable
,Contextualizable
,Serviceable
public class WorkflowNameSystemProperty
extends AbstractIndexableSystemProperty<String,String,ModelAwareDataAwareAmetysObject>
SystemProperty
which represents the current workflow name of an ametys object.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected WorkflowHelper
The workflow helperprotected WorkflowProvider
The workflow providerstatic final String
Solr field name.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 -
Method Summary
Modifier and TypeMethodDescriptiongetDefaultCriterionWidgetParameters
(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 onegetQuery
(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Get theQuery
associated to the given value.Retrieves the name of the element's solr facet fieldRetrieves the name of the element's solr fieldRetrieves the name of the element's solr sort fieldprotected String
Retrieves the id of the property's typegetValue
(ModelAwareDataAwareAmetysObject ametysObject) Get the element's valuevoid
service
(ServiceManager manager) valueToJSON
(ModelAwareDataAwareAmetysObject ametysObject, DataContext context) Convert the property into a JSON objectvoid
valueToSAX
(ContentHandler contentHandler, ModelAwareDataAwareAmetysObject ametysObject, DataContext context) Generates SAX events for the propertyMethods 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, getDefaultCriterionEnumerator, 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.search.model.SystemProperty
getColumnWidth, getConverter, getRenderer, isDisplayable
-
Field Details
-
SOLR_FIELD_NAME
Solr field name.- See Also:
-
_workflowProvider
The workflow provider -
_workflowHelper
The workflow helper
-
-
Constructor Details
-
WorkflowNameSystemProperty
public WorkflowNameSystemProperty()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractIndexableStaticProperty<String,
String, ModelAwareDataAwareAmetysObject> - Throws:
ServiceException
-
getQuery
public Query getQuery(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Description copied from interface:CriterionDefinitionAwareElementDefinition
Get theQuery
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
Description copied from interface:IndexationAwareElementDefinition
Retrieves the name of the element's solr field- Returns:
- the name of the element's solr field
-
getSolrSortFieldName
Description copied from interface:IndexationAwareElementDefinition
Retrieves the name of the element's solr sort field- Specified by:
getSolrSortFieldName
in interfaceIndexationAwareElementDefinition<String,
ModelAwareDataAwareAmetysObject> - Overrides:
getSolrSortFieldName
in classAbstractIndexableStaticProperty<String,
String, ModelAwareDataAwareAmetysObject> - Returns:
- the name of the element's solr sort field
-
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
-
getValue
Description copied from interface:IndexationAwareElementDefinition
Get the element's value- Parameters:
ametysObject
- the ametysObject containing the element- Returns:
- the values to index.
-
valueToJSON
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
- theContentHandler
that will receive the SAX eventsametysObject
- 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
-
getTypeId
Description copied from class:AbstractProperty
Retrieves the id of the property's type- Specified by:
getTypeId
in classAbstractProperty<String,
ModelAwareDataAwareAmetysObject> - Returns:
- the id of the property's type
-
getDefaultCriterionWidgetParameters
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.
-