psdi.mbo

Class MboValueData

  • java.lang.Object
    • psdi.mbo.MboValueData
  • All Implemented Interfaces:
    java.io.Serializable


    public class MboValueData
    extends java.lang.Object
    implements java.io.Serializable
    Class used by a GUI client to access information about length, data type etc. of a field. Implements Serializable and is returned to the client over a remote connection so care must be taken in making this larger!
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      MboValueData(MboValue mv)
      Construct using a MboValue class as the basis !
      MboValueData(MboValue mv, boolean ignoreFieldFlags)
      MboValueData object constructed by this constructor doesn't include the readonly and required flag if ignoreFieldFlags is true.
      MboValueData(MboValueInfo mvi)
      Construct using a MboValueInfo class as the basis !
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      ApplicationError getApplicationError()
      Returns the ApplicationError associated with the MboValue.
      java.lang.String[] getAppLink()
      Return the applink.
      MaxType getClonedMaxType()
      Returns a cloned copy of the MaxType object corresponding to this MboValueData Object.
      java.lang.String getData()
      Return the actual contents of the field.
      boolean getDataAsBoolean()
      Returns the content of the field as boolean.
      java.util.Date getDataAsDate()
      Returns the content of the field as Date.
      double getDataAsDouble()
      Returns the content of the field as double.
      float getDataAsFloat()
      Returns the content of the field as float.
      int getDataAsInt()
      Returns the content of the field as int.
      long getDataAsLong()
      Returns the content of the field as long.
      java.lang.Object getDataAsObject()
      Returns the content of the field in an Object.
      java.lang.Object getDataAsObject(int dataType)
      Returns the content of the field in an Object of the given data type.
      int getLength()
      Maximum length of the field.
      java.lang.String getLookupName()
      Return the lookup name.
      java.lang.String getProcessValue()
      Provide to UI framework the current value which was sent for processing and caused an error.
      int getTypeAsInt()
      Return the type of the object as an Int value.
      boolean hasList()
      Has the field got a look up list ?
      boolean hasLongDescription()
      Does this field have long Description potentially available.
      boolean isApplicationRequired()
      Return whether or not the application has marked this field as conditional required
      boolean isHidden() 
      boolean isNull()
      Returns whether the content of the field is null.
      boolean isNumeric()
      Returns true of field is defined as a numeric type
      boolean isReadOnly()
      Is the field read only ?
      boolean isRequired()
      Is this field required ?
      void overrideStringData(java.lang.String newValue)
      This should be called only in very special circumstances related to conversion of a value between locales (for example, maxattributecfg.defaultvalue).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MboValueData

        public MboValueData(MboValueInfo mvi)
        Construct using a MboValueInfo class as the basis !
      • MboValueData

        public MboValueData(MboValue mv)
        Construct using a MboValue class as the basis !
      • MboValueData

        public MboValueData(MboValue mv,
                            boolean ignoreFieldFlags)
        MboValueData object constructed by this constructor doesn't include the readonly and required flag if ignoreFieldFlags is true.
        Parameters:
        mv -
        ignoreFieldFlags -
    • Method Detail

      • isNumeric

        public boolean isNumeric()
        Returns true of field is defined as a numeric type
        Returns:
        type as defined in MXFormat
      • getTypeAsInt

        public int getTypeAsInt()
        Return the type of the object as an Int value. The constants for these types are defined in the MXFormat class.
        Returns:
        type as defined in MXFormat
      • getLength

        public int getLength()
        Maximum length of the field.
        Returns:
        maximum length of the field
      • getData

        public java.lang.String getData()
        Return the actual contents of the field.
        Returns:
        the contents of this field
      • getDataAsObject

        public java.lang.Object getDataAsObject()
                                         throws MXException
        Returns the content of the field in an Object.
        Throws:
        MXException
      • getDataAsObject

        public java.lang.Object getDataAsObject(int dataType)
                                         throws MXException
        Returns the content of the field in an Object of the given data type.
        Throws:
        MXException
      • getDataAsBoolean

        public boolean getDataAsBoolean()
                                 throws MXException
        Returns the content of the field as boolean.
        Returns:
        the contents of this field
        Throws:
        MXException
      • getDataAsDate

        public java.util.Date getDataAsDate()
                                     throws MXException
        Returns the content of the field as Date.
        Returns:
        the contents of this field
        Throws:
        MXException
      • getDataAsDouble

        public double getDataAsDouble()
                               throws MXException
        Returns the content of the field as double.
        Returns:
        the contents of this field
        Throws:
        MXException
      • getDataAsFloat

        public float getDataAsFloat()
                             throws MXException
        Returns the content of the field as float.
        Returns:
        the contents of this field
        Throws:
        MXException
      • getDataAsInt

        public int getDataAsInt()
                         throws MXException
        Returns the content of the field as int.
        Returns:
        the contents of this field
        Throws:
        MXException
      • getDataAsLong

        public long getDataAsLong()
                           throws MXException
        Returns the content of the field as long.
        Returns:
        the contents of this field
        Throws:
        MXException
      • isNull

        public boolean isNull()
        Returns whether the content of the field is null.
        Returns:
        true if content is null, false if not null
      • hasList

        public boolean hasList()
        Has the field got a look up list ?
        Returns:
        true = has list, false = does not have list
      • isReadOnly

        public boolean isReadOnly()
        Is the field read only ?
        Returns:
        true = read only, false = not read only
      • isRequired

        public boolean isRequired()
        Is this field required ?
        Returns:
        true = is required, false = not required
      • isHidden

        public boolean isHidden()
      • hasLongDescription

        public boolean hasLongDescription()
        Does this field have long Description potentially available. (This is regardless of whether data actually exists for the long description.)
        Returns:
        true = has long description, false = does not have long description
      • getClonedMaxType

        public MaxType getClonedMaxType()
        Returns a cloned copy of the MaxType object corresponding to this MboValueData Object.
        Returns:
        cloned copy of MaxType
      • getAppLink

        public java.lang.String[] getAppLink()
        Return the applink. Only valid if the mbo value data is constructed from MboValue.
        Returns:
      • getLookupName

        public java.lang.String getLookupName()
        Return the lookup name. Only valid if the mbo value data is constructed from MboValue.
        Returns:
      • overrideStringData

        public void overrideStringData(java.lang.String newValue)
        This should be called only in very special circumstances related to conversion of a value between locales (for example, maxattributecfg.defaultvalue).
        Parameters:
        newValue -
      • getProcessValue

        public java.lang.String getProcessValue()
        Provide to UI framework the current value which was sent for processing and caused an error.
      • getApplicationError

        public ApplicationError getApplicationError()
        Returns the ApplicationError associated with the MboValue. Returns null if there is not one.
      • isApplicationRequired

        public boolean isApplicationRequired()
        Return whether or not the application has marked this field as conditional required
        Returns: