com.ibm.cics.server
Class Resource

java.lang.Object
  extended by com.ibm.cics.server.API
      extended by com.ibm.cics.server.Resource
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
RemotableResource, URIMap, WebService, XmlTransform

public abstract class Resource
extends API
implements java.io.Serializable

This abstract class provides the common implementation for named resources.

It provides the following properties:

name
A String which is the name of the CICS resource (program, TSQ etc.).
description
A String which is a brief description of the resource.

See Also:
Serialized Form
Since CICS TS version:
1.3
Since package version:
1.0

Constructor Summary
Resource()
          Construct a default resource.
 
Method Summary
 java.lang.String getDescription()
          Return the description of the resource.
 java.lang.String getName()
          Return the name of the CICS resource.
 void setDescription(java.lang.String description)
          Sets the description of the resource.
 void setName(java.lang.String name)
          Sets the CICS resource name corresponding to this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Resource

public Resource()
Construct a default resource.

Since CICS TS version:
1.3
Since package version:
1.0
Method Detail

getDescription

public java.lang.String getDescription()
Return the description of the resource.

Returns:
the resource description
Since CICS TS version:
1.3
Since package version:
1.0

getName

public java.lang.String getName()
Return the name of the CICS resource.

Returns:
the resource name
Since CICS TS version:
1.3
Since package version:
1.0

setDescription

public void setDescription(java.lang.String description)
Sets the description of the resource.

Parameters:
description - the description of the CICS resource
Since CICS TS version:
1.3
Since package version:
1.0

setName

public void setName(java.lang.String name)
             throws java.lang.NullPointerException
Sets the CICS resource name corresponding to this object.

Parameters:
name - the name of the CICS resource
Throws:
java.lang.NullPointerException - if the name is null
Since CICS TS version:
1.3
Since package version:
1.0