com.ibm.workflow.api
Interface Container

All Known Subinterfaces:
ReadOnlyContainer, ReadWriteContainer

public interface Container


Method Summary
 int allLeafCount()
          Returns the number of leaf elements of the container including the MQ Workflow predefined members.
 ContainerElement[] allLeaves()
          Returns all leaf elements of the container including the MQ Workflow predefined members.
 byte[] asStream()
          Returns the container as a binary stream of data.
 byte[] getBuffer(java.lang.String qualifiedName)
          Returns the value of the specified container leaf element in Java.
 byte[] getBuffer2(java.lang.String qualifiedName, int index)
          Returns the value of the specified container leaf element in Java.
 double getDouble(java.lang.String qualifiedName)
          Returns the value of the specified container leaf element in Java.
 double getDouble2(java.lang.String qualifiedName, int index)
          Returns the value of the specified container leaf element in Java.
 ContainerElement getElement(java.lang.String qualifiedName)
          Provides access to a container element.
 int getLong(java.lang.String qualifiedName)
          Returns the value of the specified container leaf element in Java.
 int getLong2(java.lang.String qualifiedName, int index)
          Returns the value of the specified container leaf element in Java.
 java.lang.String getString(java.lang.String qualifiedName)
          Returns the value of the specified container leaf element in Java.
 java.lang.String getString2(java.lang.String qualifiedName, int index)
          Returns the value of the specified container leaf element in Java.
 boolean isEmpty()
          Indicates whether no container information is available.
 int leafCount()
          Returns the number of user-defined leaf elements of the container.
 ContainerElement[] leaves()
          Returns all user-defined leaf elements of the container.
 int memberCount()
          Returns the number of structural members in the container.
 ContainerElement[] structMembers()
          Returns the structural members of the container.
 java.lang.String type()
          Returns the type of the container, that is, the data structure name.
 

Method Detail

isEmpty

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

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

allLeafCount

public 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.

allLeaves

public 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.

leafCount

public 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.

leaves

public 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.

memberCount

public 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.

structMembers

public ContainerElement[] structMembers()
                                 throws FmcException
Returns the structural members of the container.

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

type

public java.lang.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.

asStream

public byte[] asStream()
                throws FmcException
Returns the container as a binary stream of data.
Throws:
FmcException - thrown if an API error or a communication error occurred.

getBuffer

public byte[] getBuffer(java.lang.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.

getBuffer2

public byte[] getBuffer2(java.lang.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.

getDouble

public double getDouble(java.lang.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.

getDouble2

public double getDouble2(java.lang.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.

getElement

public ContainerElement getElement(java.lang.String qualifiedName)
                            throws FmcException
Provides access to a container element.

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

getLong

public int getLong(java.lang.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.

getLong2

public int getLong2(java.lang.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.

getString

public java.lang.String getString(java.lang.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.

getString2

public java.lang.String getString2(java.lang.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.


© Copyright IBM Corporation 1999, 2007. All Rights Reserved.