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

Class EventConfigurationModel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    ProcessEventConfigurationModel
    public class EventConfigurationModel
extends ItemModel
    Generated model class for type EventConfiguration first defined at extension apiregistryservices.

    Event exporting configuration.

    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 _DESTINATIONTARGET2EVENTCONFIGURATION
      Generated relation code constant for relation DestinationTarget2EventConfiguration defining source attribute destinationTarget in extension apiregistryservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CONVERTERBEAN
      Generated constant - Attribute key of EventConfiguration.converterBean attribute defined at extension apiregistryservices.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of EventConfiguration.description attribute defined at extension apiregistryservices.
      static java.lang.String DESTINATIONTARGET
      Generated constant - Attribute key of EventConfiguration.destinationTarget attribute defined at extension apiregistryservices.
      static java.lang.String EVENTCLASS
      Generated constant - Attribute key of EventConfiguration.eventClass attribute defined at extension apiregistryservices.
      static java.lang.String EVENTPROPERTYCONFIGURATIONS
      Generated constant - Attribute key of EventConfiguration.eventPropertyConfigurations attribute defined at extension apiregistryservices.
      static java.lang.String EXPORTFLAG
      Generated constant - Attribute key of EventConfiguration.exportFlag attribute defined at extension apiregistryservices.
      static java.lang.String EXPORTNAME
      Generated constant - Attribute key of EventConfiguration.exportName attribute defined at extension apiregistryservices.
      static java.lang.String EXTENSIONNAME
      Generated constant - Attribute key of EventConfiguration.extensionName attribute defined at extension apiregistryservices.
      static java.lang.String MAPPINGTYPE
      Generated constant - Attribute key of EventConfiguration.mappingType attribute defined at extension apiregistryservices.
      static java.lang.String PRIORITY
      Generated constant - Attribute key of EventConfiguration.priority attribute defined at extension apiregistryservices.
      static java.lang.String VERSION
      Generated constant - Attribute key of EventConfiguration.version 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
      EventConfigurationModel()
      Generated constructor - Default constructor for generic creation.
      EventConfigurationModel​(DestinationTargetModel _destinationTarget, java.lang.String _eventClass, java.lang.String _exportName)
      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
      EventConfigurationModel​(DestinationTargetModel _destinationTarget, java.lang.String _eventClass, java.lang.String _exportName, ItemModel _owner)
      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
      EventConfigurationModel​(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 getConverterBean()
      Generated method - Getter of the EventConfiguration.converterBean attribute defined at extension apiregistryservices.
      java.lang.String getDescription()
      Generated method - Getter of the EventConfiguration.description attribute defined at extension apiregistryservices.
      DestinationTargetModel getDestinationTarget()
      Generated method - Getter of the EventConfiguration.destinationTarget attribute defined at extension apiregistryservices.
      java.lang.String getEventClass()
      Generated method - Getter of the EventConfiguration.eventClass attribute defined at extension apiregistryservices.
      java.util.List<EventPropertyConfigurationModel> getEventPropertyConfigurations()
      Generated method - Getter of the EventConfiguration.eventPropertyConfigurations attribute defined at extension apiregistryservices.
      java.lang.String getExportName()
      Generated method - Getter of the EventConfiguration.exportName attribute defined at extension apiregistryservices.
      java.lang.String getExtensionName()
      Generated method - Getter of the EventConfiguration.extensionName attribute defined at extension apiregistryservices.
      EventMappingType getMappingType()
      Generated method - Getter of the EventConfiguration.mappingType attribute defined at extension apiregistryservices.
      EventPriority getPriority()
      Generated method - Getter of the EventConfiguration.priority attribute defined at extension apiregistryservices.
      int getVersion()
      Generated method - Getter of the EventConfiguration.version attribute defined at extension apiregistryservices.
      boolean isExportFlag()
      Generated method - Getter of the EventConfiguration.exportFlag attribute defined at extension apiregistryservices.
      void setConverterBean​(java.lang.String value)
      Generated method - Setter of EventConfiguration.converterBean attribute defined at extension apiregistryservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of EventConfiguration.description attribute defined at extension apiregistryservices.
      void setDestinationTarget​(DestinationTargetModel value)
      Generated method - Initial setter of EventConfiguration.destinationTarget attribute defined at extension apiregistryservices.
      void setEventClass​(java.lang.String value)
      Generated method - Setter of EventConfiguration.eventClass attribute defined at extension apiregistryservices.
      void setEventPropertyConfigurations​(java.util.List<EventPropertyConfigurationModel> value)
      Generated method - Setter of EventConfiguration.eventPropertyConfigurations attribute defined at extension apiregistryservices.
      void setExportFlag​(boolean value)
      Generated method - Setter of EventConfiguration.exportFlag attribute defined at extension apiregistryservices.
      void setExportName​(java.lang.String value)
      Generated method - Setter of EventConfiguration.exportName attribute defined at extension apiregistryservices.
      void setExtensionName​(java.lang.String value)
      Generated method - Setter of EventConfiguration.extensionName attribute defined at extension apiregistryservices.
      void setMappingType​(EventMappingType value)
      Generated method - Setter of EventConfiguration.mappingType attribute defined at extension apiregistryservices.
      void setPriority​(EventPriority value)
      Generated method - Setter of EventConfiguration.priority attribute defined at extension apiregistryservices.
      void setVersion​(int value)
      Generated method - Initial setter of EventConfiguration.version 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

      • _DESTINATIONTARGET2EVENTCONFIGURATION

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

      • EVENTCLASS

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

      • VERSION

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

      • EXPORTFLAG

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

      • PRIORITY

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

      • EXPORTNAME

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

      • MAPPINGTYPE

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

      • CONVERTERBEAN

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

      • DESCRIPTION

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

      • EXTENSIONNAME

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

      • EVENTPROPERTYCONFIGURATIONS

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

      • DESTINATIONTARGET

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

    • Constructor Detail

      • EventConfigurationModel

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

      • EventConfigurationModel

        public EventConfigurationModel​(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

      • EventConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public EventConfigurationModel​(DestinationTargetModel _destinationTarget,
                               java.lang.String _eventClass,
                               java.lang.String _exportName)
        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:
        _destinationTarget - initial attribute declared by type EventConfiguration at extension apiregistryservices
        _eventClass - initial attribute declared by type EventConfiguration at extension apiregistryservices
        _exportName - initial attribute declared by type EventConfiguration at extension apiregistryservices

      • EventConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public EventConfigurationModel​(DestinationTargetModel _destinationTarget,
                               java.lang.String _eventClass,
                               java.lang.String _exportName,
                               ItemModel _owner)
        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:
        _destinationTarget - initial attribute declared by type EventConfiguration at extension apiregistryservices
        _eventClass - initial attribute declared by type EventConfiguration at extension apiregistryservices
        _exportName - initial attribute declared by type EventConfiguration at extension apiregistryservices
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getConverterBean

        @Accessor(qualifier="converterBean",
          type=GETTER)
public java.lang.String getConverterBean()
        Generated method - Getter of the EventConfiguration.converterBean attribute defined at extension apiregistryservices.
        Returns:
        the converterBean - Spring Bean Name

      • getDescription

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

      • getDestinationTarget

        @Accessor(qualifier="destinationTarget",
          type=GETTER)
public DestinationTargetModel getDestinationTarget()
        Generated method - Getter of the EventConfiguration.destinationTarget attribute defined at extension apiregistryservices.
        Returns:
        the destinationTarget - Destination Target

      • getEventClass

        @Accessor(qualifier="eventClass",
          type=GETTER)
public java.lang.String getEventClass()
        Generated method - Getter of the EventConfiguration.eventClass attribute defined at extension apiregistryservices.
        Returns:
        the eventClass - Full path of Class

      • getEventPropertyConfigurations

        @Accessor(qualifier="eventPropertyConfigurations",
          type=GETTER)
public java.util.List<EventPropertyConfigurationModel> getEventPropertyConfigurations()
        Generated method - Getter of the EventConfiguration.eventPropertyConfigurations attribute defined at extension apiregistryservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the eventPropertyConfigurations - Event Property Configurations

      • getExportName

        @Accessor(qualifier="exportName",
          type=GETTER)
public java.lang.String getExportName()
        Generated method - Getter of the EventConfiguration.exportName attribute defined at extension apiregistryservices.
        Returns:
        the exportName - Name of the event in the target system

      • getExtensionName

        @Accessor(qualifier="extensionName",
          type=GETTER)
public java.lang.String getExtensionName()
        Generated method - Getter of the EventConfiguration.extensionName attribute defined at extension apiregistryservices.
        Returns:
        the extensionName - Name of the EC extension where the event class is defined

      • getMappingType

        @Accessor(qualifier="mappingType",
          type=GETTER)
public EventMappingType getMappingType()
        Generated method - Getter of the EventConfiguration.mappingType attribute defined at extension apiregistryservices.
        Returns:
        the mappingType - Way of event data mapping

      • getPriority

        @Accessor(qualifier="priority",
          type=GETTER)
public EventPriority getPriority()
        Generated method - Getter of the EventConfiguration.priority attribute defined at extension apiregistryservices.
        Returns:
        the priority - Export Priority

      • getVersion

        @Accessor(qualifier="version",
          type=GETTER)
public int getVersion()
        Generated method - Getter of the EventConfiguration.version attribute defined at extension apiregistryservices.
        Returns:
        the version - Event Configuration Version

      • isExportFlag

        @Accessor(qualifier="exportFlag",
          type=GETTER)
public boolean isExportFlag()
        Generated method - Getter of the EventConfiguration.exportFlag attribute defined at extension apiregistryservices.
        Returns:
        the exportFlag - Export Flag. Indicates whether the event or its specification is exported to its target destination.

      • setConverterBean

        @Accessor(qualifier="converterBean",
          type=SETTER)
public void setConverterBean​(java.lang.String value)
        Generated method - Setter of EventConfiguration.converterBean attribute defined at extension apiregistryservices.
        Parameters:
        value - the converterBean - Spring Bean Name

      • setDescription

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

      • setDestinationTarget

        @Accessor(qualifier="destinationTarget",
          type=SETTER)
public void setDestinationTarget​(DestinationTargetModel value)
        Generated method - Initial setter of EventConfiguration.destinationTarget attribute defined at extension apiregistryservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the destinationTarget - Destination Target

      • setEventClass

        @Accessor(qualifier="eventClass",
          type=SETTER)
public void setEventClass​(java.lang.String value)
        Generated method - Setter of EventConfiguration.eventClass attribute defined at extension apiregistryservices.
        Parameters:
        value - the eventClass - Full path of Class

      • setEventPropertyConfigurations

        @Accessor(qualifier="eventPropertyConfigurations",
          type=SETTER)
public void setEventPropertyConfigurations​(java.util.List<EventPropertyConfigurationModel> value)
        Generated method - Setter of EventConfiguration.eventPropertyConfigurations attribute defined at extension apiregistryservices.
        Parameters:
        value - the eventPropertyConfigurations - Event Property Configurations

      • setExportFlag

        @Accessor(qualifier="exportFlag",
          type=SETTER)
public void setExportFlag​(boolean value)
        Generated method - Setter of EventConfiguration.exportFlag attribute defined at extension apiregistryservices.
        Parameters:
        value - the exportFlag - Export Flag. Indicates whether the event or its specification is exported to its target destination.

      • setExportName

        @Accessor(qualifier="exportName",
          type=SETTER)
public void setExportName​(java.lang.String value)
        Generated method - Setter of EventConfiguration.exportName attribute defined at extension apiregistryservices.
        Parameters:
        value - the exportName - Name of the event in the target system

      • setExtensionName

        @Accessor(qualifier="extensionName",
          type=SETTER)
public void setExtensionName​(java.lang.String value)
        Generated method - Setter of EventConfiguration.extensionName attribute defined at extension apiregistryservices.
        Parameters:
        value - the extensionName - Name of the EC extension where the event class is defined

      • setMappingType

        @Accessor(qualifier="mappingType",
          type=SETTER)
public void setMappingType​(EventMappingType value)
        Generated method - Setter of EventConfiguration.mappingType attribute defined at extension apiregistryservices.
        Parameters:
        value - the mappingType - Way of event data mapping

      • setPriority

        @Accessor(qualifier="priority",
          type=SETTER)
public void setPriority​(EventPriority value)
        Generated method - Setter of EventConfiguration.priority attribute defined at extension apiregistryservices.
        Parameters:
        value - the priority - Export Priority

      • setVersion

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