com.ibm.workflow.api
Interface ContainerElement


public interface ContainerElement


Method Summary
 ContainerElement[] arrayElements()
          Returns the array elements of the container element.
 int cardinality()
          Returns the number of array elements of the container element.
 java.lang.String fullName()
          Returns the fully-qualified dotted name of the container element.
 byte[] getBuffer()
          Returns the value of the specified container element leaf element in Java.
 byte[] getBuffer2(int index)
          Returns the value of the specified container element leaf element in Java.
 double getDouble()
          Returns the value of the specified container element leaf element in Java.
 double getDouble2(int index)
          Returns the value of the specified container element leaf element in Java.
 ContainerElement getElement(java.lang.String qualifiedName)
          Provides access to an element of the container element.
 int getLong()
          Returns the value of the specified container element leaf element in Java.
 int getLong2(int index)
          Returns the value of the specified container element leaf element in Java.
 java.lang.String getString()
          Returns the value of the specified container element leaf element in Java.
 java.lang.String getString2(int index)
          Returns the value of the specified container element leaf element in Java.
 boolean isArray()
          Indicates whether the container element is an array.
 boolean isEmpty()
          Indicates whether no container element information is available.
 boolean isLeaf()
          Indicates whether the container element is a leaf.
 boolean isStruct()
          Indicates whether the container element is a structure itself.
 int leafCount()
          Returns the number of leaf elements of the container element.
 ContainerElement[] leaves()
          Returns all leaf elements of the container element.
 int memberCount()
          Returns the number of structural members in the container element.
 java.lang.String name()
          Returns the name of the container element.
 ContainerElement[] structMembers()
          Returns the structural members of the container element.
 java.lang.String type()
          Returns the type of the container element, that is, the data structure name.
 

Method Detail

isEmpty

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

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

arrayElements

public ContainerElement[] arrayElements()
                                 throws FmcException
Returns the array elements of the container element.

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

cardinality

public int cardinality()
                throws FmcException
Returns the number of array elements of the container element.

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

fullName

public java.lang.String fullName()
                          throws FmcException
Returns the fully-qualified dotted name of the container element.

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

isArray

public boolean isArray()
                throws FmcException
Indicates whether the container element is an array.

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

isLeaf

public boolean isLeaf()
               throws FmcException
Indicates whether the container element is a leaf.

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

isStruct

public boolean isStruct()
                 throws FmcException
Indicates whether the container element is a structure itself.

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

leafCount

public int leafCount()
              throws FmcException
Returns the number of leaf elements of the container element.

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

leaves

public ContainerElement[] leaves()
                          throws FmcException
Returns all leaf elements of the container element.

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

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

name

public java.lang.String name()
                      throws FmcException
Returns the name of the container element.

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

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 element, that is, the data structure name.

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

getBuffer

public byte[] getBuffer()
                 throws FmcException
Returns the value of the specified container element 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(int index)
                  throws FmcException
Returns the value of the specified container element 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()
                 throws FmcException
Returns the value of the specified container element 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(int index)
                  throws FmcException
Returns the value of the specified container element 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 an element of the container element.

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

getLong

public int getLong()
            throws FmcException
Returns the value of the specified container element 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(int index)
             throws FmcException
Returns the value of the specified container element 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()
                           throws FmcException
Returns the value of the specified container element 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(int index)
                            throws FmcException
Returns the value of the specified container element 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.