Package com.softwaremining.cics.wrappers

Class BMSString

java.lang.Object
com.softwaremining.wrappers.AbstractCBLField
com.softwaremining.wrappers.AbstractCBLPrimitive
com.softwaremining.wrappers.CBLString
com.softwaremining.cics.wrappers.BMSString
All Implemented Interfaces:
IBMSField, AbstractDataObject, IFormatTypes, ICBLContainer, ICBLDataType, IFieldContainer, ISMDataType, ISMObject, ISMString
public class BMSString extends CBLString implements IBMSField
BMS screen define fields which are one of three types:
  • length field
  • Flag/Attribute field
  • Main field (BMSField) - this is where the actual data resides

  • Constructor Details

  • Method Details

    • createSubField

      public AbstractCBLField createSubField(int[] index)
      Overrides:
      createSubField in class CBLString

    • setIntensity

      public IBMSField setIntensity(int intensity)
      Description copied from interface: IBMSField
      changes intensity from default BMSField.INTENSITY_NORMAL to BMSField.INTENSITY_DARK or BMSField.INTENSITY_BRIGHT.
      Specified by:
      setIntensity in interface IBMSField

    • setNumeric

      public IBMSField setNumeric(boolean numeric)
      fields are AlphaNumeric by default. NOTE: Setting this to true or false will force the field UN-PROTECTED, and disables the SKIP attribute
      Specified by:
      setNumeric in interface IBMSField
      Parameters:
      numeric -
      Returns:

    • setProtected

      public IBMSField setProtected(boolean protect)
      fields are Unprotected / Enabled by default.
      Specified by:
      setProtected in interface IBMSField
      Parameters:
      numeric -
      Returns:

    • setSkip

      public IBMSField setSkip(boolean skip)
      Description copied from interface: IBMSField
      This is equivalent of DISABLING an input field. The cursor will not stop at fields marked as SKIP
      Specified by:
      setSkip in interface IBMSField

    • setModified

      public IBMSField setModified(boolean modified)
      Description copied from interface: IBMSField
      Sets the isModified flag on outgoing field. (value of field.isModifiedByFrontEnd() will not have been changed) CICS RECEIVE will only report values which have been altered since previous SEND. E.g. after a Receive statement, bufferI.xyzI will contain NULL values if the on-screen value of XYZ is not changed between SEND and RECEIVE. using bufferI.ObjectxyzI.SetModified(true) will ensure the ON-SCREEN value is returned irrespective of whether it had been modified or not.
      Specified by:
      setModified in interface IBMSField
      Returns:

    • setFocus

      public IBMSField setFocus()
      Description copied from interface: IBMSField
      Set focus on the field
      Specified by:
      setFocus in interface IBMSField

    • getLengthTyped

      public int getLengthTyped()
      Description copied from interface: IBMSField
      returns the length of characters typed in front end. E.g. if the field has been defined as 20 chars, but user has only typed "ABC" - then value 3 will be returned.
      Specified by:
      getLengthTyped in interface IBMSField

    • setLengthTyped

      public void setLengthTyped(int newLen)
      Description copied from interface: IBMSField
      Resets the length attrib fields to new value
      Specified by:
      setLengthTyped in interface IBMSField

    • setLengthTyped

      public void setLengthTyped(String newLen)

    • isInputValid

      public boolean isInputValid()
      Description copied from interface: IBMSField
      checks if the length-field is -1
      Specified by:
      isInputValid in interface IBMSField
      Returns:

    • isModified

      public boolean isModified()
      checks if attrib-A is not equal to Hex40 Value
      Specified by:
      isModified in interface IBMSField

    • isInputAvailable

      public boolean isInputAvailable()
      Checks if the number of characters typed by user is greater than 0.
      ie if L-Field has greater than 0 characters.
      Specified by:
      isInputAvailable in interface IBMSField
      Returns:

    • isErased

      public boolean isErased()
      Checks if the attribute field has modified (MDT) value.
      Specified by:
      isErased in interface IBMSField
      Returns:

    • isErased2

      public boolean isErased2()
      Checks if the attribute field has LOW-VALUES
      Specified by:
      isErased2 in interface IBMSField

    • resetAttributes

      public void resetAttributes()
      Assigns LOW-VALUES to attribute field
      Specified by:
      resetAttributes in interface IBMSField

    • createBlank

      public AbstractCBLField createBlank()
      For internal use only
      Overrides:
      createBlank in class CBLString
      Returns:

    • setColor

      public void setColor(String newColour)
      For Output Fields COLOR Field is only provided when BMS EXTATT=yes is specified on the original application (rare)
      Specified by:
      setColor in interface IBMSField
      Parameters:
      newColour -

    • hasFocus

      public boolean hasFocus()

    • isBMSString

      public boolean isBMSString()
      For internal use only.
      This provides same functionality of if (this instanceOf BMSString) without building a dependency on CICS libraries.
      Overrides:
      isBMSString in class AbstractCBLField
      Returns: