com.ibm.cics.server

Class EnterRequest

  • All Implemented Interfaces:
    java.io.Serializable


    public class EnterRequest
    extends API
    implements java.io.Serializable

    This Bean provides the Java equivalent to the EXEC CICS ENTER command.

    It defines the following properties:

    TraceIdentifier
    An identifier for the trace entry
    Resource
    A name which is copied into the resource field of the trace entry
    Exception
    A boolean which causes CICS to write a trace entry in the event of an exception even if the master and user trace flags are set off.
    See Also:
    Serialized Form
    Since CICS TS version:
    1.3
    Since package version:
    1.0
    • Constructor Summary

      Constructors 
      Constructor and Description
      EnterRequest()
      Construct an EnterRequest bean.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void enterTrace()
      Perform a trace entry request
      void enterTrace(byte[] data)
      Perform a trace entry request with supplied data
      java.lang.String getResource()
      Return the Resource
      short getTraceIdentifier()
      Return the TraceIdentifier
      boolean isException()
      Is a trace entry to be produced on an exception if trace flags are off?
      void setException(boolean traceException)
      Control whether trace entry is produced on exception if trace flags are off
      void setResource(java.lang.String resource)
      Set the Resource.
      void setTraceIdentifier(short traceId)
      Set the TraceIdentifier
      • Methods inherited from class java.lang.Object

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

      • EnterRequest

        public EnterRequest()
        Construct an EnterRequest bean.
        Since CICS TS version:
        1.3
        Since package version:
        1.0
    • Method Detail

      • getResource

        public java.lang.String getResource()
        Return the Resource
        Returns:
        the Resource
        Since CICS TS version:
        1.3
        Since package version:
        1.0
      • getTraceIdentifier

        public short getTraceIdentifier()
        Return the TraceIdentifier
        Returns:
        the TraceIdentifier
        Since CICS TS version:
        1.3
        Since package version:
        1.0
      • isException

        public boolean isException()
        Is a trace entry to be produced on an exception if trace flags are off?
        Returns:
        true if a trace entry is to be produced on an exception if trace flags are off.
        Since CICS TS version:
        1.3
        Since package version:
        1.0
      • setException

        public void setException(boolean traceException)
        Control whether trace entry is produced on exception if trace flags are off
        Parameters:
        traceException - true means a trace entry will be produced on an exception if trace flags are off, false means not.
        Since CICS TS version:
        1.3
        Since package version:
        1.0
      • setResource

        public void setResource(java.lang.String resource)
        Set the Resource. The resource name must be 8 characters long. If the value supplied is too short then it is padded with spaces. If the value is too long then it is truncated.
        Parameters:
        resource - the Resource
        Since CICS TS version:
        1.3
        Since package version:
        1.0
      • setTraceIdentifier

        public void setTraceIdentifier(short traceId)
        Set the TraceIdentifier
        Parameters:
        traceId - the trace identifier
        Since CICS TS version:
        1.3
        Since package version:
        1.0