com.ibm.cics.server

Class StartRequest

  • All Implemented Interfaces:
    java.io.Serializable


    public class StartRequest
    extends RemotableResource

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

    In addition to the properties it inherits from RemotableResource, it defines the following properties:

    transId
    The name of the transaction to be started. This is the same as the name property inherited from Resource via RemotableResource.
    time
    A Calendar object which defines the time at which the task should be started.
    ID
    A name which is used as the name of a local Temporary Storage Queue.
    terminal
    A name which is used as the name of a local Terminal.
    userId
    The user ID under whose authority the started transaction is to run.
    rTransaction
    The name of the transaction that the started transaction will retrieve.
    rTerminal
    The name of the terminal that the started transaction will retrieve.
    queueName
    Specifies the name of a Temporary Storage Queue that may be used by the started transaction. If a name shorter than eight bytes is used it is padded to eight bytes.
    checked
    Indicates if CICS should provide full error checking and function. The default is true.
    isProtected
    A boolean which indicates if the start request is not to be processed until the task making the request has issued a SYNCPOINT. The default is false.
    See Also:
    com.ibm.cics.server.API for general restrictions on using the JCICS API., Serialized Form
    Since CICS TS version:
    1.3
    Since package version:
    1.0.0
    • Constructor Summary

      Constructors 
      Constructor and Description
      StartRequest()
      Construct a StartRequest bean.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void cancel()
      Cancel a previous start request.
      byte[] getID()
      Return the ID that uniquely identifies the start request.
      java.lang.String getIDAsString()
      Return the ID that uniquely identifies the start request as a string, using the LOCALCCSID character encoding to convert from the byte[] format in which the name is stored.
      byte[] getQueueName()
      Return the queueName of the start request.
      java.lang.String getQueueNameAsString()
      Return the queue name of the start request as a string, using the LOCALCCSID character encoding to convert from the internal byte[] format in which the name is stored.
      java.lang.String getRTerminal()
      Get the name specified as the terminal name to be retrieved by the started task.
      java.lang.String getRTransaction()
      Get the name specified as the transaction name to be retrieved by the started task.
      java.lang.String getTerminal()
      Return the name of the terminal to be used as the principal facility of the started task.
      java.util.Calendar getTime()
      Return the time at which the task will be started.
      java.lang.String getTransId()
      Return the name of the Transaction to be started.
      java.lang.String getUserId()
      Return the user ID under whose authority the task is to run.
      boolean isChecked()
      Is this start request to be checked?
      boolean isProtected()
      Is this start request to be protected?
      void issue()
      Issue the start request passing no data to the started task.
      void issue(byte[] data)
      Issue the start request, passing a byte array to the started task.
      void issue(Channel chan)
      Issue the start request, passing a Channel to the started task.
      void resetRequestData()
      Reset the required fields on the StartRequest to allow reuse of the object.
      void setChecked(boolean checked)
      Control whether start request is checked or not.
      void setID(byte[] id)
      Set the ID that uniquely identifies the start request.
      void setIDFromString(java.lang.String id)
      Set the ID that uniquely identifies the start request from a String.
      void setProtected(boolean isProtected)
      Control whether start request is protected or not.
      void setQueueName(byte[] queueName)
      Sets the queueName of the start request.
      void setQueueNameFromString(java.lang.String name)
      Sets the queue name of the start request.
      void setRTerminal(java.lang.String rTerminal)
      Set the terminal name to be retrieved by the started task.
      void setRTransaction(java.lang.String rTransaction)
      Set the transaction name to be retrieved by the started task.
      void setTerminal(java.lang.String terminal)
      Set the name of the terminal to be used as the principal facility of the started task.
      void setTime(java.util.Calendar calendar)
      Set the time at which the task will be started.
      void setTransId(java.lang.String transId)
      Set the name of the Transaction to be started.
      void setUserId(java.lang.String userId)
      Set the user ID under whose authority the task will run.
      • Methods inherited from class java.lang.Object

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

      • StartRequest

        public StartRequest()
        Construct a StartRequest bean.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
    • Method Detail

      • setTransId

        public void setTransId(java.lang.String transId)
        Set the name of the Transaction to be started.
        Parameters:
        transId - Transaction to be started
        Since CICS TS version:
        3.1
        Since package version:
        1.0.0
      • getID

        public byte[] getID()
        Return the ID that uniquely identifies the start request.
        Returns:
        String the ID of the start request.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getIDAsString

        public java.lang.String getIDAsString()
        Return the ID that uniquely identifies the start request as a string, using the LOCALCCSID character encoding to convert from the byte[] format in which the name is stored.
        Returns:
        String the ID of the start request.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getQueueName

        public byte[] getQueueName()
        Return the queueName of the start request.
        Returns:
        byte[] the start request queueName
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getQueueNameAsString

        public java.lang.String getQueueNameAsString()
        Return the queue name of the start request as a string, using the LOCALCCSID character encoding to convert from the internal byte[] format in which the name is stored.
        Returns:
        String the TSQ name
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getRTerminal

        public java.lang.String getRTerminal()
        Get the name specified as the terminal name to be retrieved by the started task.
        Returns:
        the name
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getRTransaction

        public java.lang.String getRTransaction()
        Get the name specified as the transaction name to be retrieved by the started task.
        Returns:
        the name
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getTerminal

        public java.lang.String getTerminal()
        Return the name of the terminal to be used as the principal facility of the started task.
        Returns:
        the name of the terminal
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getTime

        public java.util.Calendar getTime()
        Return the time at which the task will be started.
        Returns:
        Calendar a Calendar object for the current default locale which indicates the time at which the task will be started.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • getUserId

        public java.lang.String getUserId()
        Return the user ID under whose authority the task is to run.
        Returns:
        String userId The user ID under whose authority the task is to run.
        Since CICS TS version:
        5.2
        Since package version:
        1.501.0
      • getTransId

        public java.lang.String getTransId()
        Return the name of the Transaction to be started.
        Returns:
        String transId Transaction to be started
        Since CICS TS version:
        3.1
        Since package version:
        1.0.0
      • isChecked

        public boolean isChecked()
        Is this start request to be checked?
        Returns:
        true if it is to be checked, false otherwise.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • isProtected

        public boolean isProtected()
        Is this start request to be protected?
        Returns:
        true if it is to be protected, false otherwise.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setChecked

        public void setChecked(boolean checked)
        Control whether start request is checked or not.
        Parameters:
        checked - true means request is checked; false means it is not.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setID

        public void setID(byte[] id)
        Set the ID that uniquely identifies the start request. If the id passed in is shorter than 8 bytes it is padded to 8 bytes with bytes containing 0x00.
        Parameters:
        id - The unique name. Its length should be <= 8.
        Throws:
        java.lang.NullPointerException - start id is null
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setIDFromString

        public void setIDFromString(java.lang.String id)
        Set the ID that uniquely identifies the start request from a String.
        Parameters:
        id - The unique name. If the length of the String is less than eight it is padded to 8 characters using space characters and it is then converted to bytes using the platform's default encoding. If the length of the resulting byte array is more than eight then it is truncated to exactly eight bytes.
        Throws:
        java.lang.NullPointerException - start id is null
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setProtected

        public void setProtected(boolean isProtected)
        Control whether start request is protected or not.
        Parameters:
        isProtected - true means request is protected; false means it is not.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setQueueName

        public void setQueueName(byte[] queueName)
                          throws java.lang.NullPointerException
        Sets the queueName of the start request.
        Parameters:
        queueName - the queueName of the start request. If the length of the queue name is less than eight it is padded with the hex value of blank in the platform's default character encoding. Over-length queueNames will be truncated.
        Throws:
        java.lang.NullPointerException - queueName is null
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setQueueNameFromString

        public void setQueueNameFromString(java.lang.String name)
                                    throws java.lang.NullPointerException
        Sets the queue name of the start request.
        Parameters:
        name - the queue name of the start request as a string. If the length of the String is less than eight it is padded to 8 characters using space characters and it is then converted to bytes using the platform's default encoding. If the length of the resulting byte array is more than eight then it is truncated to exactly eight bytes.
        Throws:
        java.lang.NullPointerException - queueName is null
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setRTerminal

        public void setRTerminal(java.lang.String rTerminal)
        Set the terminal name to be retrieved by the started task.
        Parameters:
        rTerminal - the terminal name.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setRTransaction

        public void setRTransaction(java.lang.String rTransaction)
        Set the transaction name to be retrieved by the started task.
        Parameters:
        rTransaction - the transaction name.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setTerminal

        public void setTerminal(java.lang.String terminal)
        Set the name of the terminal to be used as the principal facility of the started task.
        Parameters:
        terminal - the name of the terminal
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setTime

        public void setTime(java.util.Calendar calendar)
        Set the time at which the task will be started.
        Parameters:
        calendar - A Calendar object for the time at which the task is to be started.
        Since CICS TS version:
        1.3
        Since package version:
        1.0.0
      • setUserId

        public void setUserId(java.lang.String userId)
        Set the user ID under whose authority the task will run.
        Parameters:
        userId - the user ID under whose authority the task will run.
        Since CICS TS version:
        5.2
        Since package version:
        1.501.0
      • resetRequestData

        public void resetRequestData()
        Reset the required fields on the StartRequest to allow reuse of the object. Should be called before calling issue(Channel) if issue() or issue(byte[]) have already been called on this object.
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0