Package de.hybris.platform.apiregistryservices.model.events

Class EventPropertyConfigurationModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class EventPropertyConfigurationModel
extends ItemModel
    Generated model class for type EventPropertyConfiguration first defined at extension apiregistryservices.

    Exporting configuration for single event property.

    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _EVENTCONFIGURATION2EVENTPROPERTYCONFIGURATION
      Generated relation code constant for relation EventConfiguration2EventPropertyConfiguration defining source attribute eventConfiguration in extension apiregistryservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of EventPropertyConfiguration.description attribute defined at extension apiregistryservices.
      static java.lang.String EVENTCONFIGURATION
      Generated constant - Attribute key of EventPropertyConfiguration.eventConfiguration attribute defined at extension apiregistryservices.
      static java.lang.String EVENTCONFIGURATIONPOS
      Generated constant - Attribute key of EventPropertyConfiguration.eventConfigurationPOS attribute defined at extension apiregistryservices.
      static java.lang.String EXAMPLES
      Generated constant - Attribute key of EventPropertyConfiguration.examples attribute defined at extension apiregistryservices.
      static java.lang.String PROPERTYMAPPING
      Generated constant - Attribute key of EventPropertyConfiguration.propertyMapping attribute defined at extension apiregistryservices.
      static java.lang.String PROPERTYNAME
      Generated constant - Attribute key of EventPropertyConfiguration.propertyName attribute defined at extension apiregistryservices.
      static java.lang.String REQUIRED
      Generated constant - Attribute key of EventPropertyConfiguration.required attribute defined at extension apiregistryservices.
      static java.lang.String TITLE
      Generated constant - Attribute key of EventPropertyConfiguration.title attribute defined at extension apiregistryservices.
      static java.lang.String TYPE
      Generated constant - Attribute key of EventPropertyConfiguration.type attribute defined at extension apiregistryservices.

      • Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

    • Constructor Summary

      Constructors 
      Constructor Description
      EventPropertyConfigurationModel()
      Generated constructor - Default constructor for generic creation.
      EventPropertyConfigurationModel​(EventConfigurationModel _eventConfiguration, ItemModel _owner, java.lang.String _propertyMapping, java.lang.String _propertyName, java.lang.String _title, java.lang.String _type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      EventPropertyConfigurationModel​(EventConfigurationModel _eventConfiguration, java.lang.String _propertyMapping, java.lang.String _propertyName, java.lang.String _title, java.lang.String _type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      EventPropertyConfigurationModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Generated method - Getter of the EventPropertyConfiguration.description attribute defined at extension apiregistryservices.
      EventConfigurationModel getEventConfiguration()
      Generated method - Getter of the EventPropertyConfiguration.eventConfiguration attribute defined at extension apiregistryservices.
      java.util.Map<java.lang.String,​java.lang.String> getExamples()
      Generated method - Getter of the EventPropertyConfiguration.examples attribute defined at extension apiregistryservices.
      java.lang.String getPropertyMapping()
      Generated method - Getter of the EventPropertyConfiguration.propertyMapping attribute defined at extension apiregistryservices.
      java.lang.String getPropertyName()
      Generated method - Getter of the EventPropertyConfiguration.propertyName attribute defined at extension apiregistryservices.
      java.lang.String getTitle()
      Generated method - Getter of the EventPropertyConfiguration.title attribute defined at extension apiregistryservices.
      java.lang.String getType()
      Generated method - Getter of the EventPropertyConfiguration.type attribute defined at extension apiregistryservices.
      boolean isRequired()
      Generated method - Getter of the EventPropertyConfiguration.required attribute defined at extension apiregistryservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of EventPropertyConfiguration.description attribute defined at extension apiregistryservices.
      void setEventConfiguration​(EventConfigurationModel value)
      Generated method - Initial setter of EventPropertyConfiguration.eventConfiguration attribute defined at extension apiregistryservices.
      void setExamples​(java.util.Map<java.lang.String,​java.lang.String> value)
      Generated method - Setter of EventPropertyConfiguration.examples attribute defined at extension apiregistryservices.
      void setPropertyMapping​(java.lang.String value)
      Generated method - Setter of EventPropertyConfiguration.propertyMapping attribute defined at extension apiregistryservices.
      void setPropertyName​(java.lang.String value)
      Generated method - Initial setter of EventPropertyConfiguration.propertyName attribute defined at extension apiregistryservices.
      void setRequired​(boolean value)
      Generated method - Setter of EventPropertyConfiguration.required attribute defined at extension apiregistryservices.
      void setTitle​(java.lang.String value)
      Generated method - Setter of EventPropertyConfiguration.title attribute defined at extension apiregistryservices.
      void setType​(java.lang.String value)
      Generated method - Setter of EventPropertyConfiguration.type attribute defined at extension apiregistryservices.

      • Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • _EVENTCONFIGURATION2EVENTPROPERTYCONFIGURATION

        public static final java.lang.String _EVENTCONFIGURATION2EVENTPROPERTYCONFIGURATION
        Generated relation code constant for relation EventConfiguration2EventPropertyConfiguration defining source attribute eventConfiguration in extension apiregistryservices.
        See Also:
        Constant Field Values

      • PROPERTYNAME

        public static final java.lang.String PROPERTYNAME
        Generated constant - Attribute key of EventPropertyConfiguration.propertyName attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • PROPERTYMAPPING

        public static final java.lang.String PROPERTYMAPPING
        Generated constant - Attribute key of EventPropertyConfiguration.propertyMapping attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • TYPE

        public static final java.lang.String TYPE
        Generated constant - Attribute key of EventPropertyConfiguration.type attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • TITLE

        public static final java.lang.String TITLE
        Generated constant - Attribute key of EventPropertyConfiguration.title attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • REQUIRED

        public static final java.lang.String REQUIRED
        Generated constant - Attribute key of EventPropertyConfiguration.required attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of EventPropertyConfiguration.description attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • EXAMPLES

        public static final java.lang.String EXAMPLES
        Generated constant - Attribute key of EventPropertyConfiguration.examples attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • EVENTCONFIGURATIONPOS

        public static final java.lang.String EVENTCONFIGURATIONPOS
        Generated constant - Attribute key of EventPropertyConfiguration.eventConfigurationPOS attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

      • EVENTCONFIGURATION

        public static final java.lang.String EVENTCONFIGURATION
        Generated constant - Attribute key of EventPropertyConfiguration.eventConfiguration attribute defined at extension apiregistryservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EventPropertyConfigurationModel

        public EventPropertyConfigurationModel()
        Generated constructor - Default constructor for generic creation.

      • EventPropertyConfigurationModel

        public EventPropertyConfigurationModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • EventPropertyConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public EventPropertyConfigurationModel​(EventConfigurationModel _eventConfiguration,
                                       java.lang.String _propertyMapping,
                                       java.lang.String _propertyName,
                                       java.lang.String _title,
                                       java.lang.String _type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _eventConfiguration - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _propertyMapping - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _propertyName - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _title - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _type - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices

      • EventPropertyConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public EventPropertyConfigurationModel​(EventConfigurationModel _eventConfiguration,
                                       ItemModel _owner,
                                       java.lang.String _propertyMapping,
                                       java.lang.String _propertyName,
                                       java.lang.String _title,
                                       java.lang.String _type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _eventConfiguration - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _owner - initial attribute declared by type Item at extension core
        _propertyMapping - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _propertyName - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _title - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices
        _type - initial attribute declared by type EventPropertyConfiguration at extension apiregistryservices

    • Method Detail

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription()
        Generated method - Getter of the EventPropertyConfiguration.description attribute defined at extension apiregistryservices.
        Returns:
        the description - Human-readable event property description

      • getEventConfiguration

        @Accessor(qualifier="eventConfiguration",
          type=GETTER)
public EventConfigurationModel getEventConfiguration()
        Generated method - Getter of the EventPropertyConfiguration.eventConfiguration attribute defined at extension apiregistryservices.
        Returns:
        the eventConfiguration - Event Configuration

      • getExamples

        @Accessor(qualifier="examples",
          type=GETTER)
public java.util.Map<java.lang.String,​java.lang.String> getExamples()
        Generated method - Getter of the EventPropertyConfiguration.examples attribute defined at extension apiregistryservices.
        Returns:
        the examples - Extracting result example

      • getPropertyMapping

        @Accessor(qualifier="propertyMapping",
          type=GETTER)
public java.lang.String getPropertyMapping()
        Generated method - Getter of the EventPropertyConfiguration.propertyMapping attribute defined at extension apiregistryservices.
        Returns:
        the propertyMapping - Extracting Path

      • getPropertyName

        @Accessor(qualifier="propertyName",
          type=GETTER)
public java.lang.String getPropertyName()
        Generated method - Getter of the EventPropertyConfiguration.propertyName attribute defined at extension apiregistryservices.
        Returns:
        the propertyName - Target property Id

      • getTitle

        @Accessor(qualifier="title",
          type=GETTER)
public java.lang.String getTitle()
        Generated method - Getter of the EventPropertyConfiguration.title attribute defined at extension apiregistryservices.
        Returns:
        the title - Human-readable Title

      • getType

        @Accessor(qualifier="type",
          type=GETTER)
public java.lang.String getType()
        Generated method - Getter of the EventPropertyConfiguration.type attribute defined at extension apiregistryservices.
        Returns:
        the type - Result Type

      • isRequired

        @Accessor(qualifier="required",
          type=GETTER)
public boolean isRequired()
        Generated method - Getter of the EventPropertyConfiguration.required attribute defined at extension apiregistryservices.
        Returns:
        the required - Required Flag

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value)
        Generated method - Setter of EventPropertyConfiguration.description attribute defined at extension apiregistryservices.
        Parameters:
        value - the description - Human-readable event property description

      • setEventConfiguration

        @Accessor(qualifier="eventConfiguration",
          type=SETTER)
public void setEventConfiguration​(EventConfigurationModel value)
        Generated method - Initial setter of EventPropertyConfiguration.eventConfiguration attribute defined at extension apiregistryservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the eventConfiguration - Event Configuration

      • setExamples

        @Accessor(qualifier="examples",
          type=SETTER)
public void setExamples​(java.util.Map<java.lang.String,​java.lang.String> value)
        Generated method - Setter of EventPropertyConfiguration.examples attribute defined at extension apiregistryservices.
        Parameters:
        value - the examples - Extracting result example

      • setPropertyMapping

        @Accessor(qualifier="propertyMapping",
          type=SETTER)
public void setPropertyMapping​(java.lang.String value)
        Generated method - Setter of EventPropertyConfiguration.propertyMapping attribute defined at extension apiregistryservices.
        Parameters:
        value - the propertyMapping - Extracting Path

      • setPropertyName

        @Accessor(qualifier="propertyName",
          type=SETTER)
public void setPropertyName​(java.lang.String value)
        Generated method - Initial setter of EventPropertyConfiguration.propertyName attribute defined at extension apiregistryservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the propertyName - Target property Id

      • setRequired

        @Accessor(qualifier="required",
          type=SETTER)
public void setRequired​(boolean value)
        Generated method - Setter of EventPropertyConfiguration.required attribute defined at extension apiregistryservices.
        Parameters:
        value - the required - Required Flag

      • setTitle

        @Accessor(qualifier="title",
          type=SETTER)
public void setTitle​(java.lang.String value)
        Generated method - Setter of EventPropertyConfiguration.title attribute defined at extension apiregistryservices.
        Parameters:
        value - the title - Human-readable Title

      • setType

        @Accessor(qualifier="type",
          type=SETTER)
public void setType​(java.lang.String value)
        Generated method - Setter of EventPropertyConfiguration.type attribute defined at extension apiregistryservices.
        Parameters:
        value - the type - Result Type