All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.Container

public interface Container
Version:
3.2.0.2

Method Index

 o allLeafCount()
Returns the number of leaf elements of the container including the MQ Workflow predefined members.
 o allLeaves()
Returns all leaf elements of the container including the MQ Workflow predefined members.
 o getBuffer(String)
Returns the value of the specified container leaf element in Java.
 o getBuffer2(String, int)
Returns the value of the specified container leaf element in Java.
 o getDouble(String)
Returns the value of the specified container leaf element in Java.
 o getDouble2(String, int)
Returns the value of the specified container leaf element in Java.
 o getElement(String)
Provides access to a container element.
 o getLong(String)
Returns the value of the specified container leaf element in Java.
 o getLong2(String, int)
Returns the value of the specified container leaf element in Java.
 o getString(String)
Returns the value of the specified container leaf element in Java.
 o getString2(String, int)
Returns the value of the specified container leaf element in Java.
 o isEmpty()
Indicates whether no container information is available.
 o leafCount()
Returns the number of user-defined leaf elements of the container.
 o leaves()
Returns all user-defined leaf elements of the container.
 o memberCount()
Returns the number of structural members in the container.
 o structMembers()
Returns the structural members of the container.
 o type()
Returns the type of the container, that is, the data structure name.

Methods

 o isEmpty
 public abstract boolean isEmpty() throws FmcException
Indicates whether no container information is available.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o allLeafCount
 public abstract int allLeafCount() throws FmcException
Returns the number of leaf elements of the container including the MQ Workflow predefined members.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o allLeaves
 public abstract ContainerElement[] allLeaves() throws FmcException
Returns all leaf elements of the container including the MQ Workflow predefined members.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o leafCount
 public abstract int leafCount() throws FmcException
Returns the number of user-defined leaf elements of the container.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o leaves
 public abstract ContainerElement[] leaves() throws FmcException
Returns all user-defined leaf elements of the container.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o memberCount
 public abstract int memberCount() throws FmcException
Returns the number of structural members in the container.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o structMembers
 public abstract ContainerElement[] structMembers() throws FmcException
Returns the structural members of the container.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o type
 public abstract String type() throws FmcException
Returns the type of the container, that is, the data structure name.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getBuffer
 public abstract byte[] getBuffer(String qualifiedName) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is of type BINARY.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getBuffer2
 public abstract byte[] getBuffer2(String qualifiedName,
                                   int index) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is part of an array and of type BINARY.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getDouble
 public abstract double getDouble(String qualifiedName) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is of type FLOAT.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getDouble2
 public abstract double getDouble2(String qualifiedName,
                                   int index) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is part of an array and of type FLOAT.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getElement
 public abstract ContainerElement getElement(String qualifiedName) throws FmcException
Provides access to a container element.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getLong
 public abstract int getLong(String qualifiedName) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is of type LONG.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getLong2
 public abstract int getLong2(String qualifiedName,
                              int index) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is part of an array and of type LONG.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getString
 public abstract String getString(String qualifiedName) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is of type STRING.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getString2
 public abstract String getString2(String qualifiedName,
                                   int index) throws FmcException
Returns the value of the specified container leaf element in Java. The leaf is part of an array and of type STRING.

Throws: FmcException
thrown if an API error or a communication error occurred.

All Packages  Class Hierarchy  This Package  Previous  Next  Index