Package com.onenetwork.platform.common

Class OBFixlenFieldFormat

java.lang.Object
com.onenetwork.platform.common.Model
com.onenetwork.platform.common.OBFixlenFieldFormat
All Implemented Interfaces:
com.onenetwork.platform.common.impl.Child<OBFixlenRecordFormat>, Model, java.io.Serializable
public class OBFixlenFieldFormat
extends com.onenetwork.platform.common.Model
implements java.io.Serializable, com.onenetwork.platform.common.impl.Child<OBFixlenRecordFormat>
Defines the format of the fields that compose a record in a flat file.

Java class for OBFixlenFieldFormat complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="OBFixlenFieldFormat">
   <complexContent>
     <extension base="{http://www.onenetwork.com/Platform}Model">
       <sequence>
         <element name="InputRefId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Error" type="{http://www.onenetwork.com/Platform}Error" minOccurs="0"/>
         <element name="LevelCreationDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LevelModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="FieldName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Mnemonic" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Position" type="{http://www.onenetwork.com/Platform}NullableInteger" minOccurs="0"/>
         <element name="FieldRuleName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="FieldRuleEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Udfs" type="{http://www.onenetwork.com/Platform}NameValuePairList" minOccurs="0"/>
         <element name="Issue" type="{http://www.onenetwork.com/Platform}Issue" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.onenetwork.com/Platform}MDFs" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Attribute" type="{http://www.onenetwork.com/Platform}AttributeValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:
Serialized Form

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.util.List<AttributeValue> attributes  
    protected StatusMessage error  
    protected java.lang.String fieldName  
    protected java.lang.String fieldRuleEnterpriseName  
    protected java.lang.String fieldRuleName  
    protected java.lang.String inputRefId  
    protected java.util.List<Issue> issues  
    protected java.util.Calendar levelCreationDate  
    protected java.util.Calendar levelModifiedDate  
    protected java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> mdFsList  
    protected java.lang.String mnemonic  
    static com.onenetwork.platform.data.model.impl.ModelLevelType MODEL_LEVEL_TYPE
    Constant reference to the ModelLevelType for this JAXB.
    static com.onenetwork.platform.data.model.impl.ModelType MODEL_TYPE
    Constant reference to the ModelType for this JAXB.
    protected OBFixlenRecordFormat parent
    Reference to the parent OBFixlenRecordFormat
    protected java.lang.Integer position  
    static java.lang.String STANDARD_MODEL_NAME
    Constant reference to the standard model name for this JAXB.
    protected java.lang.Long sysFieldRuleId  
    protected com.onenetwork.platform.common.NameValuePairList udfs  

    Fields inherited from class com.onenetwork.platform.common.Model

    keyCoordinationEnabled

  • Constructor Summary

    Constructors 
    Constructor Description
    OBFixlenFieldFormat()  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)
    A Model object is considered "equal" to another Model object if it is a Model of the same type and its Natural Key fields are identical.
    java.util.List<AttributeValue> getAttributes()
    Gets the value of the attributes property.
    StatusMessage getError()
    Gets the value of the error property.
    java.lang.String getFieldName()
    Gets the value of the fieldName property.
    java.lang.String getFieldRuleEnterpriseName()
    Gets the value of the fieldRuleEnterpriseName property.
    java.lang.String getFieldRuleName()
    Gets the value of the fieldRuleName property.
    java.lang.String getInputRefId()
    Gets the value of the inputRefId property.
    java.util.List<Issue> getIssues()
    Gets the value of the issues property.
    java.util.Calendar getLevelCreationDate()
    Gets the value of the levelCreationDate property.
    java.util.Calendar getLevelModifiedDate()
    Gets the value of the levelModifiedDate property.
    java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> getMDFsList()
    Gets the value of the mdFsList property.
    java.lang.String getMnemonic()
    Gets the value of the mnemonic property.
    com.onenetwork.platform.data.model.impl.ModelLevelType getModelLevelType()
    methods to get ModelLevelType for this JAXB.
    com.onenetwork.platform.data.model.impl.ModelType getModelType()
    methods to get ModelType for this JAXB.
    OBFixlenRecordFormat getParent()
    Returns the parent OBFixlenRecordFormat.
    int getPosition()  
    java.lang.String getStandardModelName()
    method to get standard model name for this JAXB.
    java.lang.Long getSysFieldRuleId()
    Returns the surrogate id value for SysFieldRuleId.
    com.onenetwork.platform.common.NameValuePairList getUdfs()
    Gets the value of the udfs property.
    int hashCode()  
    protected java.lang.String internalToString()  
    boolean isSetAttributes()  
    boolean isSetError()  
    boolean isSetFieldName()  
    boolean isSetFieldRuleEnterpriseName()  
    boolean isSetFieldRuleName()  
    boolean isSetInputRefId()  
    boolean isSetIssues()  
    boolean isSetLevelCreationDate()  
    boolean isSetLevelModifiedDate()  
    boolean isSetMDFsList()  
    boolean isSetMnemonic()  
    boolean isSetPosition()  
    boolean isSetUdfs()  
    com.onenetwork.platform.common.Issue issueOff​(java.lang.String issueName)
    Utility method to create an issue and set it on JAXB
    com.onenetwork.platform.common.Issue issueOn​(java.lang.String issueName, IssueSeverity issueSeverity)
    Utility method to create an issue and set it on JAXB
    void setError​(StatusMessage value)
    Sets the value of the error property.
    void setFieldName​(java.lang.String value)
    Sets the value of the fieldName property.
    void setFieldRuleEnterpriseName​(java.lang.String value)
    Sets the value of FieldRuleEnterpriseName, and also nullifies the following surrogate ids: SysFieldRuleId.
    void setFieldRuleName​(java.lang.String value)
    Sets the value of FieldRuleName, and also nullifies the following surrogate ids: SysFieldRuleId.
    void setInputRefId​(java.lang.String value)
    Sets the value of the inputRefId property.
    void setLevelCreationDate​(java.util.Calendar value)
    Sets the value of the levelCreationDate property.
    void setLevelModifiedDate​(java.util.Calendar value)
    Sets the value of the levelModifiedDate property.
    void setMnemonic​(java.lang.String value)
    Sets the value of the mnemonic property.
    void setParent​(OBFixlenRecordFormat parent)
    Sets the parent OBFixlenRecordFormat.
    void setPosition​(int value)
    Sets the value of the position property.
    void setSysFieldRuleId​(java.lang.Long value, boolean nullifyNaturalKeys)
    Sets the surrogate id value for SysFieldRuleId.
    void setUdfs​(com.onenetwork.platform.common.NameValuePairList value)
    Sets the value of the udfs property.
    java.lang.String toStrContrib()
    Not intended for use by Clients
    void unsetAttributes()  
    void unsetIssues()  
    void unsetMDFsList()  
    void unsetPosition()  

    Methods inherited from class com.onenetwork.platform.common.Model

    addWarning, copyTransientFields, diff, enableKeyCoordination, fromJSONObject, getActionName, getAttribute, getAttributeValue, getLastModifiedDate, getLastModifiedUser, getMDF, getMDFs, getMDFs, getRider, getRider, getRiders, getSysId, getTransientField, getTransientFields, getUdf, getUdfNames, getUdfs, getWarnings, setActionName, setAttribute, setError, setLastModifiedDate, setLastModifiedUser, setMDF, setSysId, setTransientField, setUdf, toJSONObject, toJSONObject, toJSONObjectExternal, toJSONObjectFullySerialized, toString, toXML

    Methods inherited from class java.lang.Object

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

  • Field Details

    • inputRefId

      protected java.lang.String inputRefId

    • error

      protected StatusMessage error

    • levelCreationDate

      protected java.util.Calendar levelCreationDate

    • levelModifiedDate

      protected java.util.Calendar levelModifiedDate

    • fieldName

      protected java.lang.String fieldName

    • mnemonic

      protected java.lang.String mnemonic

    • position

      protected java.lang.Integer position

    • fieldRuleName

      protected java.lang.String fieldRuleName

    • fieldRuleEnterpriseName

      protected java.lang.String fieldRuleEnterpriseName

    • udfs

      protected com.onenetwork.platform.common.NameValuePairList udfs

    • issues

      protected java.util.List<Issue> issues

    • mdFsList

      protected java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> mdFsList

    • attributes

      protected java.util.List<AttributeValue> attributes

    • parent

      protected OBFixlenRecordFormat parent
      Reference to the parent OBFixlenRecordFormat

    • MODEL_TYPE

      public static final com.onenetwork.platform.data.model.impl.ModelType MODEL_TYPE
      Constant reference to the ModelType for this JAXB.

    • MODEL_LEVEL_TYPE

      public static final com.onenetwork.platform.data.model.impl.ModelLevelType MODEL_LEVEL_TYPE
      Constant reference to the ModelLevelType for this JAXB.

    • STANDARD_MODEL_NAME

      public static final java.lang.String STANDARD_MODEL_NAME
      Constant reference to the standard model name for this JAXB.

    • sysFieldRuleId

      protected java.lang.Long sysFieldRuleId

  • Constructor Details

  • Method Details

    • getInputRefId

      public java.lang.String getInputRefId()
      Gets the value of the inputRefId property.
      Returns:
      possible object is String

    • setInputRefId

      public void setInputRefId​(java.lang.String value)
      Sets the value of the inputRefId property.
      Parameters:
      value - allowed object is String

    • isSetInputRefId

      public boolean isSetInputRefId()

    • getError

      public StatusMessage getError()
      Gets the value of the error property.
      Specified by:
      getError in interface Model
      Overrides:
      getError in class com.onenetwork.platform.common.Model
      Returns:
      possible object is ErrorDef

    • setError

      public void setError​(StatusMessage value)
      Sets the value of the error property.
      Specified by:
      setError in interface Model
      Overrides:
      setError in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is ErrorDef

    • isSetError

      public boolean isSetError()

    • getLevelCreationDate

      public java.util.Calendar getLevelCreationDate()
      Gets the value of the levelCreationDate property.
      Returns:
      possible object is String

    • setLevelCreationDate

      public void setLevelCreationDate​(java.util.Calendar value)
      Sets the value of the levelCreationDate property.
      Parameters:
      value - allowed object is String

    • isSetLevelCreationDate

      public boolean isSetLevelCreationDate()

    • getLevelModifiedDate

      public java.util.Calendar getLevelModifiedDate()
      Gets the value of the levelModifiedDate property.
      Returns:
      possible object is String

    • setLevelModifiedDate

      public void setLevelModifiedDate​(java.util.Calendar value)
      Sets the value of the levelModifiedDate property.
      Parameters:
      value - allowed object is String

    • isSetLevelModifiedDate

      public boolean isSetLevelModifiedDate()

    • getFieldName

      public java.lang.String getFieldName()
      Gets the value of the fieldName property.
      Returns:
      possible object is String

    • setFieldName

      public void setFieldName​(java.lang.String value)
      Sets the value of the fieldName property.
      Parameters:
      value - allowed object is String

    • isSetFieldName

      public boolean isSetFieldName()

    • getMnemonic

      public java.lang.String getMnemonic()
      Gets the value of the mnemonic property.
      Returns:
      possible object is String

    • setMnemonic

      public void setMnemonic​(java.lang.String value)
      Sets the value of the mnemonic property.
      Parameters:
      value - allowed object is String

    • isSetMnemonic

      public boolean isSetMnemonic()

    • setPosition

      public void setPosition​(int value)
      Sets the value of the position property.
      Parameters:
      value - allowed object is String

    • isSetPosition

      public boolean isSetPosition()

    • getFieldRuleName

      public java.lang.String getFieldRuleName()
      Gets the value of the fieldRuleName property.
      Returns:
      possible object is String

    • isSetFieldRuleName

      public boolean isSetFieldRuleName()

    • getFieldRuleEnterpriseName

      public java.lang.String getFieldRuleEnterpriseName()
      Gets the value of the fieldRuleEnterpriseName property.
      Returns:
      possible object is String

    • isSetFieldRuleEnterpriseName

      public boolean isSetFieldRuleEnterpriseName()

    • getUdfs

      public com.onenetwork.platform.common.NameValuePairList getUdfs()
      Gets the value of the udfs property.
      Overrides:
      getUdfs in class com.onenetwork.platform.common.Model
      Returns:
      possible object is NameValuePairList

    • setUdfs

      public void setUdfs​(com.onenetwork.platform.common.NameValuePairList value)
      Sets the value of the udfs property.
      Overrides:
      setUdfs in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is NameValuePairList

    • isSetUdfs

      public boolean isSetUdfs()
      Overrides:
      isSetUdfs in class com.onenetwork.platform.common.Model

    • getIssues

      public java.util.List<Issue> getIssues()
      Gets the value of the issues property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the issues property.

      For example, to add a new item, do as follows: 

          getIssues().add(newItem);

      Objects of the following type(s) are allowed in the list Issue

    • isSetIssues

      public boolean isSetIssues()

    • unsetIssues

      public void unsetIssues()

    • getMDFsList

      public java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> getMDFsList()
      Gets the value of the mdFsList property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mdFsList property.

      For example, to add a new item, do as follows: 

          getMDFsList().add(newItem);

      Objects of the following type(s) are allowed in the list JAXBElement<DummyMDFs> JAXBElement<MDFs>

      Overrides:
      getMDFsList in class com.onenetwork.platform.common.Model

    • isSetMDFsList

      public boolean isSetMDFsList()

    • unsetMDFsList

      public void unsetMDFsList()

    • getAttributes

      public java.util.List<AttributeValue> getAttributes()
      Gets the value of the attributes property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the attributes property.

      For example, to add a new item, do as follows: 

          getAttributes().add(newItem);

      Objects of the following type(s) are allowed in the list AttributeValue

      Overrides:
      getAttributes in class com.onenetwork.platform.common.Model

    • isSetAttributes

      public boolean isSetAttributes()

    • unsetAttributes

      public void unsetAttributes()

    • getParent

      public OBFixlenRecordFormat getParent()
      Returns the parent OBFixlenRecordFormat. This is an in-memory retrieval and does not perform a database lookup
      Specified by:
      getParent in interface com.onenetwork.platform.common.impl.Child<OBFixlenRecordFormat>
      Returns:
      parent OBFixlenRecordFormat

    • setParent

      public void setParent​(OBFixlenRecordFormat parent)
      Sets the parent OBFixlenRecordFormat. This is an in-memory set and does not perform a database write
      Specified by:
      setParent in interface com.onenetwork.platform.common.impl.Child<OBFixlenRecordFormat>
      Parameters:
      parent - new parent OBFixlenRecordFormat

    • setFieldRuleName

      public void setFieldRuleName​(java.lang.String value)
      Sets the value of FieldRuleName, and also nullifies the following surrogate ids: SysFieldRuleId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for FieldRuleName - the following will also be nullified: SysFieldRuleId

    • setFieldRuleEnterpriseName

      public void setFieldRuleEnterpriseName​(java.lang.String value)
      Sets the value of FieldRuleEnterpriseName, and also nullifies the following surrogate ids: SysFieldRuleId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for FieldRuleEnterpriseName - the following will also be nullified: SysFieldRuleId

    • getPosition

      public int getPosition()

    • unsetPosition

      public void unsetPosition()

    • issueOn

      public com.onenetwork.platform.common.Issue issueOn​(java.lang.String issueName, IssueSeverity issueSeverity)
      Utility method to create an issue and set it on JAXB

    • issueOff

      public com.onenetwork.platform.common.Issue issueOff​(java.lang.String issueName)
      Utility method to create an issue and set it on JAXB

    • equals

      public boolean equals​(java.lang.Object obj)
      Description copied from interface: Model
      A Model object is considered "equal" to another Model object if it is a Model of the same type and its Natural Key fields are identical.
      Specified by:
      equals in interface Model
      Overrides:
      equals in class java.lang.Object
      Parameters:
      obj - object to compare
      Returns:
      true if the object is the same type of Model with identical Natural Key fields

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • internalToString

      protected java.lang.String internalToString()
      Overrides:
      internalToString in class com.onenetwork.platform.common.Model

    • toStrContrib

      public java.lang.String toStrContrib()
      Not intended for use by Clients

    • getModelType

      public com.onenetwork.platform.data.model.impl.ModelType getModelType()
      methods to get ModelType for this JAXB.
      Overrides:
      getModelType in class com.onenetwork.platform.common.Model

    • getModelLevelType

      public com.onenetwork.platform.data.model.impl.ModelLevelType getModelLevelType()
      methods to get ModelLevelType for this JAXB.
      Overrides:
      getModelLevelType in class com.onenetwork.platform.common.Model

    • getStandardModelName

      public java.lang.String getStandardModelName()
      method to get standard model name for this JAXB.
      Overrides:
      getStandardModelName in class com.onenetwork.platform.common.Model

    • getSysFieldRuleId

      public java.lang.Long getSysFieldRuleId()
      Returns the surrogate id value for SysFieldRuleId. After reading a model, this will always match with the corresponding natural keys, which are: fieldRuleName, fieldRuleEnterpriseName

    • setSysFieldRuleId

      public void setSysFieldRuleId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysFieldRuleId. As a client, when you want to update the model in the database, you may set values either by natural key or by sys id, or by both. Calling this method with 'true' will nullify the natural keys for this surrogate key: fieldRuleName, fieldRuleEnterpriseName. This ensures the values don't conflict. If you are 'populating' an object and want to set both natural and surrogate keys, you should set the natural keys first, then call this method with 'false' for nullifyNaturalKeys.
      Parameters:
      value - new value for SysFieldRuleId
      nullifyNaturalKeys - true to nullify the related natural keys (fieldRuleName, fieldRuleEnterpriseName), or false to leave as is - please note that you can pass either surrogate id or natural keys to the server write API, or both