com.ibm.cics.server
Class Event

java.lang.Object
  extended by com.ibm.cics.server.Event

public class Event
extends java.lang.Object

This is the Java implementation of the EXEC CICS SIGNAL EVENT command.

Since CICS TS version:
4.1
Since package version:
1.200

Constructor Summary
Event()
          Construct an Event with no name.
Event(java.lang.String name)
          Construct an Event with the supplied name.
 
Method Summary
 java.lang.String getName()
          Get the name of the Event as known to CICS
 void setName(java.lang.String name)
          Set the name of the Event as known to CICS
 void signal()
          Signal the Event to CICS.
 void signal(byte[] fromData)
          Signal the Event to CICS with a byte array.
 void signal(byte[] fromData, int fromLength)
          Signal the Event to CICS with a byte array and length.
 void signal(Channel fromChannel)
          Signal the Event to CICS with a Channel.
 void signal(java.lang.String fromString)
          Signal the Event to CICS with a String.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Event

public Event()
Construct an Event with no name.

Since CICS TS version:
4.1
Since package version:
1.200

Event

public Event(java.lang.String name)
      throws EventErrorException
Construct an Event with the supplied name.

Parameters:
name - the name of the Event
Throws:
EventErrorException - if something goes wrong
Since CICS TS version:
4.1
Since package version:
1.200
Method Detail

getName

public java.lang.String getName()
Get the name of the Event as known to CICS

Returns:
The name of the Event
Since CICS TS version:
4.1
Since package version:
1.200

setName

public void setName(java.lang.String name)
             throws EventErrorException
Set the name of the Event as known to CICS

Parameters:
name - the name of the event
Throws:
EventErrorException - if something goes wrong
Since CICS TS version:
4.1
Since package version:
1.200

signal

public void signal()
            throws ChannelErrorException,
                   EventErrorException,
                   LengthErrorException
Signal the Event to CICS. This is equivalent to: EXEC CICS SIGNAL EVENT(eventName);

Throws:
EventErrorException - if something goes wrong
ChannelErrorException - if there is a problem with the channel
LengthErrorException - if there is a length error
Since CICS TS version:
4.1
Since package version:
1.200

signal

public void signal(java.lang.String fromString)
            throws ChannelErrorException,
                   EventErrorException,
                   LengthErrorException
Signal the Event to CICS with a String. This is equivalent to: EXEC CICS SIGNAL EVENT(eventName) FROM(fromData);

Parameters:
fromString - the data to signal
Throws:
EventErrorException - if something goes wrong
ChannelErrorException - if there is a problem with the channel
LengthErrorException - if there is a length error
Since CICS TS version:
4.1
Since package version:
1.200

signal

public void signal(byte[] fromData)
            throws ChannelErrorException,
                   EventErrorException,
                   LengthErrorException
Signal the Event to CICS with a byte array. This is equivalent to: EXEC CICS SIGNAL EVENT(eventName) FROM(fromData);

Parameters:
fromData - the data to signal
Throws:
EventErrorException - if something goes wrong
ChannelErrorException - if there is a problem with the channel
LengthErrorException - if there is a length error
Since CICS TS version:
4.1
Since package version:
1.200

signal

public void signal(byte[] fromData,
                   int fromLength)
            throws ChannelErrorException,
                   EventErrorException,
                   LengthErrorException
Signal the Event to CICS with a byte array and length. This is equivalent to: EXEC CICS SIGNAL EVENT(eventName) FROM(fromData) FROMLENGTH(fromLength);

Parameters:
fromData - the data to signal
fromLength - the length of data to signal
Throws:
EventErrorException - if something goes wrong
ChannelErrorException - if there is a problem with the channel
LengthErrorException - if there is a length error
Since CICS TS version:
4.1
Since package version:
1.200

signal

public void signal(Channel fromChannel)
            throws ChannelErrorException,
                   EventErrorException,
                   LengthErrorException
Signal the Event to CICS with a Channel. This is equivalent to: EXEC CICS SIGNAL EVENT(eventName) FROMCHANNEL(fromChannel);

Parameters:
fromChannel - the channel
Throws:
EventErrorException - if something goes wrong
ChannelErrorException - if there is a problem with the channel
LengthErrorException - if there is a length error
Since CICS TS version:
4.1
Since package version:
1.200