Package gorm.tools.job

Enum DataLayout

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DataLayout>
    public enum DataLayout
extends java.lang.Enum<DataLayout>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      List
      If dataLayout=List then data is just a json list as the data is, and errors will be in the problems field.
      Result
      If dataLayout=Result then data is a list of Result/Problem objects.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DataLayout valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DataLayout[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • Result

        public static final DataLayout Result
        If dataLayout=Result then data is a list of Result/Problem objects. Errors are mixed in and the syncJob.data is just a rendered list of the Result or Problem objects. BulkImport uses Result for example. This is not recomended anymore.

      • List

        public static final DataLayout List
        If dataLayout=List then data is just a json list as the data is, and errors will be in the problems field. BulkExport uses List for example. dataLayout=List or Map IS the recomended way. When dataLayout=List then the rendering of the data is only list of whats in each results payload. For example if processing export then this is the only one that really makes sense as it gives a list of what the query ran, such as Invoices. Would look as if the call was made to the rest endpoint for a list synchronously Since data can only support a list of entities then any issues or errors get stored in the separate problems field, syncjob.problems will be populated with error results

    • Method Detail

      • values

        public static DataLayout[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DataLayout c : DataLayout.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DataLayout valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null