CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Class ECIChannelRecord

java.lang.Object
  extended by com.ibm.connector2.cics.ECIChannelRecord
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, javax.resource.cci.MappedRecord, javax.resource.cci.Record

public class ECIChannelRecord
extends java.lang.Object
implements javax.resource.cci.MappedRecord

ECIChannelRecord is part of the API for Channels and Containers support for the CICS ECI Resource Adapters. This takes the form of a JCA MappedRecord object which Container objects can be added with get/put methods.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Constructor Summary
ECIChannelRecord(java.lang.String name)
          Creates the Channel Record.
 
Method Summary
 void clear()
          Removes all entries from the Channel
 java.lang.Object clone()
          Not supported
 boolean containsKey(java.lang.Object key)
          Returns whether or not the specified Container name exists in the Channel.
 boolean containsValue(java.lang.Object value)
          Returns whether or not the Container value is within the Channel.
 boolean equals(java.lang.Object o)
           
 java.lang.Object get(java.lang.Object name)
          Retrieves a Container from the Channel.
 java.lang.String getRecordName()
          Returns the name of the Channel record
 java.lang.String getRecordShortDescription()
          Returns a short description of this record
 int hashCode()
           
 boolean isEmpty()
          Returns whether the Channel is empty or not.
 java.util.Set keySet()
          Returns a Set with the Container names in it.
 java.lang.Object put(java.lang.Object key, java.lang.Object value)
          Adds a Container to the Channel
 void putAll(java.util.Map t)
          Puts a group of Containers in a Channel
 java.lang.Object remove(java.lang.Object name)
          Removes a Container from the Channel
 void setRecordName(java.lang.String name)
          This method does not change the record name.
 void setRecordShortDescription(java.lang.String description)
          Sets a short record description.
 int size()
          Returns the number of Containers in the Channel
 java.util.Collection values()
          Returns the contents of all the Containers in the Channel
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ECIChannelRecord

public ECIChannelRecord(java.lang.String name)
                 throws javax.resource.ResourceException
Creates the Channel Record.

Parameters:
name - This is the name of the Channel (please note this is immutable once set).
Throws:
javax.resource.ResourceException - if name is null or contains invalid Channel name chars.
Method Detail

getRecordName

public java.lang.String getRecordName()
Returns the name of the Channel record

Specified by:
getRecordName in interface javax.resource.cci.Record

getRecordShortDescription

public java.lang.String getRecordShortDescription()
Returns a short description of this record

Specified by:
getRecordShortDescription in interface javax.resource.cci.Record

setRecordName

public void setRecordName(java.lang.String name)
This method does not change the record name. Channel names are immutable. This method exists solely to conform to the MappedRecord interface.

Specified by:
setRecordName in interface javax.resource.cci.Record

setRecordShortDescription

public void setRecordShortDescription(java.lang.String description)
Sets a short record description.

Specified by:
setRecordShortDescription in interface javax.resource.cci.Record

clear

public void clear()
Removes all entries from the Channel

Specified by:
clear in interface java.util.Map

containsKey

public boolean containsKey(java.lang.Object key)
Returns whether or not the specified Container name exists in the Channel.

Specified by:
containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)
Returns whether or not the Container value is within the Channel.

Specified by:
containsValue in interface java.util.Map

get

public java.lang.Object get(java.lang.Object name)
Retrieves a Container from the Channel.

Specified by:
get in interface java.util.Map
Parameters:
name - The name of the Container to retrieve
Returns:
The container - this is null if the entry could not be found

isEmpty

public boolean isEmpty()
Returns whether the Channel is empty or not.

Specified by:
isEmpty in interface java.util.Map

keySet

public java.util.Set keySet()
Returns a Set with the Container names in it.

Specified by:
keySet in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
Adds a Container to the Channel

Specified by:
put in interface java.util.Map

putAll

public void putAll(java.util.Map t)
Puts a group of Containers in a Channel

Specified by:
putAll in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object name)
Removes a Container from the Channel

Specified by:
remove in interface java.util.Map
Parameters:
name - Container to remove

size

public int size()
Returns the number of Containers in the Channel

Specified by:
size in interface java.util.Map

values

public java.util.Collection values()
Returns the contents of all the Containers in the Channel

Specified by:
values in interface java.util.Map

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Not supported

Specified by:
clone in interface javax.resource.cci.Record
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Map
Specified by:
equals in interface javax.resource.cci.Record
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Specified by:
hashCode in interface java.util.Map
Specified by:
hashCode in interface javax.resource.cci.Record
Overrides:
hashCode in class java.lang.Object

©Copyright IBM Corp. 1994, 2014
Legal