com.ibm.cics.core.comm
Interface IConnectionCategory


public interface IConnectionCategory

Meta-object describing a category of connections. A category of connections communicate using the same metaphors. Connections with a category are identified as connection types. Descriptors for these connection types are available using getConnections(). Each connection type is described by an IConnectionDescriptor, and is associated with a specific implementation of IConnection. All connections in an IConnectionCategory must implement a common interface. The class name of is available using getConnectionType()


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getAbbreviatedName()
          Returns a short version of the name of this IConnectionCategory suitable for use in user interfaces where only a small amount of space is available to render the name.
 IConnectionDescriptor[] getConnections()
          Returns an IConnectionDescriptor for each connection type in this IConnectionCategory
 java.lang.String getConnectionType()
          Returns the name of the superclass of all IConnection implementations for connection types in this IConnectionCategory
 java.net.URL getIconPath()
          Returns a URL identifying an icon that can be used to represent this connection in user interfaces.
 java.lang.String getId()
          Gets the unique ID of this IConnectionCategory.
 java.lang.String getName()
          Gets the name of this category of connections, to be used in user interfaces.
 java.lang.Class<? extends IConnection> getType()
          Retrieves the superclass of all IConnection implementations for all connection types in this category.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Gets the name of this category of connections, to be used in user interfaces.

Returns:
the name of this IConnectionCategory

getConnections

IConnectionDescriptor[] getConnections()
Returns an IConnectionDescriptor for each connection type in this IConnectionCategory

Returns:
an array of known IConnectionDescriptors, which may be empty.

getConnectionType

java.lang.String getConnectionType()
Returns the name of the superclass of all IConnection implementations for connection types in this IConnectionCategory

Returns:
a String that is the name of a Class

getId

java.lang.String getId()
Gets the unique ID of this IConnectionCategory. Can be used to retrieve this category from the ConnectionRegistry using ConnectionRegistry.getConnectionCategory(String).

Returns:
the unique ID of this IConnectionCategory.

getAbbreviatedName

java.lang.String getAbbreviatedName()
Returns a short version of the name of this IConnectionCategory suitable for use in user interfaces where only a small amount of space is available to render the name.

Returns:
a short version of the name of this IConnectionCategory.

getIconPath

java.net.URL getIconPath()
Returns a URL identifying an icon that can be used to represent this connection in user interfaces.

Returns:
a URL for an icon, or null if none is available.

getType

java.lang.Class<? extends IConnection> getType()
                                               throws java.lang.ClassNotFoundException
Retrieves the superclass of all IConnection implementations for all connection types in this category.

Returns:
the superclass of all IConnection implementations for all connection types in this category.
Throws:
java.lang.ClassNotFoundException - if the class for this IConnectionCategory can't be found.


Copyright © 2013 IBM Corp. All Rights Reserved.