Package com.onenetwork.platform.common.field

Class FieldTypes

java.lang.Object
com.onenetwork.platform.common.field.FieldTypes
public class FieldTypes
extends java.lang.Object
List of all available FieldType as static constants.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static FieldType ADDRESS
    The Address field type represents an international mailing address.
    static FieldType ATTACHMENTS
    The Attachment field type contains an Attachment object which refers to a document such as a presentation, zip file, etc.
    static FieldType BOOLEAN
    Refers to a booelan data type; values will be of type Boolean.
    static FieldType COMPOSITE
    Composite fields are used to define fields that need multiple fields to give them a complete definition.
    static FieldType CURRENCY
    Refers to the currency field type; values will be of type Double.
    static FieldType DATE
    Refers to a date data type; values will be of type Calendar.
    static FieldType DATE_RANGE
    Refers to a Date Range field; values will be of type DateRange
    static FieldType DOUBLE
    Refers to the double field type; values will be of type Double.
    static FieldType DURATION
    Represents an amount of time, in ISO 8601 format.
    static FieldType DYNA_FIELD
    Represents the dynamic field which is a runtime-defined field which can part of the key for a model.
    static FieldType ERROR
    This field type is used to represent an error on a model.
    static FieldType FLOAT
    Represents the float data type; value will be of type Float.
    static FieldType HYPERLINK
    Represents a hyper link field; value will be of type String.
    static FieldType INTEGER
    Represents an integer field type; returned value will be of type Integer
    static FieldType LONG
    Represents a long field type; returned value will be of type Long
    static FieldType MODEL_LINK
    A Model Link field represents a reference from one model to another.
    static FieldType STATE
    Represents a state field on a model; value is of type String
    static FieldType STRING
    Represents a string field; value will be of type String.
    static FieldType STRING_ENUMERATION
    Represents a string enumeration; value will be of type String.

  • Constructor Summary

    Constructors 
    Constructor Description
    FieldTypes()  

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ADDRESS

      public static final FieldType ADDRESS
      The Address field type represents an international mailing address. It consists of various address field components, where each component specifies one of street, city, state, zip, etc. The required components and optional components may vary for different country codes

      The Address object is used to represent an ADDRESS field value.

      Example of creating an address object: 

       AddressService addressSrv = Services.get(AddressService.class);
 Address address = addressSrv.createAddress(Country.US);
 address.set(AddressComponentType.STREET_1, "4055 Valley View Ln");
 address.set(AddressComponentType.CITY, "Dallas");
 address.set(AddressComponentType.STATE, "TX");

    • ATTACHMENTS

      public static final FieldType ATTACHMENTS
      The Attachment field type contains an Attachment object which refers to a document such as a presentation, zip file, etc. The com.onenetwork.platform.data.model.Attachment object is used to represent an ATTACHMENT field value.

    • BOOLEAN

      public static final FieldType BOOLEAN
      Refers to a booelan data type; values will be of type Boolean.

    • COMPOSITE

      public static final FieldType COMPOSITE
      Composite fields are used to define fields that need multiple fields to give them a complete definition. One such example would be a volume field, which is a combination of the quantity and unit of measure. A composite value will be represented as a List of objects with each element in the array being the individual field of the component.

    • CURRENCY

      public static final FieldType CURRENCY
      Refers to the currency field type; values will be of type Double.

    • DATE

      public static final FieldType DATE
      Refers to a date data type; values will be of type Calendar.

    • DATE_RANGE

      public static final FieldType DATE_RANGE
      Refers to a Date Range field; values will be of type DateRange

    • DOUBLE

      public static final FieldType DOUBLE
      Refers to the double field type; values will be of type Double.

    • DURATION

      public static final FieldType DURATION
      Represents an amount of time, in ISO 8601 format. (PnYnMnDTnHnMnS) See http://en.wikipedia.org/wiki/ISO_8601#Durations

    • DYNA_FIELD

      public static final FieldType DYNA_FIELD
      Represents the dynamic field which is a runtime-defined field which can part of the key for a model. It will also be possible to have non-key DynaFields.

    • ERROR

      public static final FieldType ERROR
      This field type is used to represent an error on a model. Value will be of type StatusMessage

    • FLOAT

      public static final FieldType FLOAT
      Represents the float data type; value will be of type Float.

    • HYPERLINK

      public static final FieldType HYPERLINK
      Represents a hyper link field; value will be of type String. The User Interface will not do any escaping of hyperlink fields, allowing them to render natively.

    • INTEGER

      public static final FieldType INTEGER
      Represents an integer field type; returned value will be of type Integer

    • LONG

      public static final FieldType LONG
      Represents a long field type; returned value will be of type Long

    • MODEL_LINK

      public static final FieldType MODEL_LINK
      A Model Link field represents a reference from one model to another. Value will be of type ModelLinkKey. This object contains the surrogate id of the referenced object, along with its natural key components.

    • STATE

      public static final FieldType STATE
      Represents a state field on a model; value is of type String

    • STRING

      public static final FieldType STRING
      Represents a string field; value will be of type String.

    • STRING_ENUMERATION

      public static final FieldType STRING_ENUMERATION
      Represents a string enumeration; value will be of type String.

  • Constructor Details