Class IntegrationObjectClassModelBuilder

java.lang.Object
de.hybris.platform.integrationservices.IntegrationObjectClassModelBuilder

public final class IntegrationObjectClassModelBuilder extends Object
Integration object item builder to build an IntegrationObjectClassModel.
  • Constructor Details

    • IntegrationObjectClassModelBuilder

      public IntegrationObjectClassModelBuilder()
  • Method Details

    • integrationObjectClass

      public static IntegrationObjectClassModelBuilder integrationObjectClass()
      Instantiates this IntegrationObjectClassModelBuilder.
      Returns:
      an instance of IntegrationObjectClassModelBuilder.
    • integrationObjectClass

      public static IntegrationObjectClassModelBuilder integrationObjectClass(String code)
      Delegates to withCode(String) to instantiate an IntegrationObjectClassModelBuilder with a specified class code.
      Parameters:
      code - the class code.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with a class code defined.
    • withCode

      Sets the class code for this IntegrationObjectClassModelBuilder.
      Parameters:
      code - the class code.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with a class code defined.
    • withType

      public IntegrationObjectClassModelBuilder withType(Class<?> type)
      Sets the class type for this IntegrationObjectClassModelBuilder.
      Parameters:
      type - the class type to be included into an integration object.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with a class type defined.
    • root

      Sets isRoot for this class to true.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with isRoot defined as true.
    • withRoot

      public IntegrationObjectClassModelBuilder withRoot(boolean value)
      Sets isRoot for this class to a desired boolean value.
      Parameters:
      value - a boolean value for the class' getRoot property.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with getRoot set to provided boolean.
      See Also:
    • withAttribute

      Adds an IntegrationObjectClassAttribute to this class model.
      Returns:
      an instance of IntegrationObjectClassModelBuilder containing the provided attribute.
    • withIntegrationObject

      public IntegrationObjectClassModelBuilder withIntegrationObject(IntegrationObjectModel model)
      Delegates to withIntegrationObjectCode(String) to find the IntegrationObject code from the provided model.
      Parameters:
      model - an IntegrationObjectModel to obtain the IntegrationObject code from.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with the IntegrationObject code defined using the provided model.
    • withIntegrationObjectCode

      public IntegrationObjectClassModelBuilder withIntegrationObjectCode(String ioCode)
      Sets the IntegrationObject code for this class.
      Parameters:
      ioCode - an IntegrationObject code.
      Returns:
      an instance of IntegrationObjectClassModelBuilder with the IntegrationObject code defined.
    • withExcludedValidators

      public IntegrationObjectClassModelBuilder withExcludedValidators(Collection<String> excludedValidators)
      Sets the list of excluded validators for the impex execution
      Parameters:
      excludedValidators - a collection of strings with the bean names of the validators that we want to exclude from the impex execution
      Returns:
      an instance of IntegrationObjectClassModelBuilder with the excluded validators list defined
    • build

      Builds the IntegrationObjectClassModel for this builder's IntegrationObjectClass.
      Returns:
      an IntegrationObjectClassModel produced by this builder.
    • buildClassImpexHeader

      public static List<String> buildClassImpexHeader()
      Builds the Impex header for this builder's IntegrationObjectClass.
      Returns:
      the Impex header for this builder's IntegrationObjectClass.
    • buildClassImpexHeader

      public static List<String> buildClassImpexHeader(Collection<String> excludedValidators)
      Builds the Impex header for this builder's IntegrationObjectClass.
      Parameters:
      excludedValidators - containing a collection of validator bean names that we want to exclude in the impex execution
      Returns:
      the Impex header for this builder's IntegrationObjectClass.
    • buildImpexLine

      public String buildImpexLine()
      Builds the Impex body for this builder's IntegrationObjectClass.
      Returns:
      the Impex body for this builder's IntegrationObjectClass.
    • buildAttributeLines

      public List<String> buildAttributeLines()
      Builds the Impex body for attributes in this builder's IntegrationObjectClass.
      Returns:
      the Impex body for attributes in this builder's IntegrationObjectClass.