All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.ContainerElement

public interface ContainerElement
Version:
3.2.0.2

Method Index

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

Methods

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o arrayElements
 public abstract ContainerElement[] arrayElements() throws FmcException
Returns the array elements of the container element.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o cardinality
 public abstract 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.
 o fullName
 public abstract 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.
 o isArray
 public abstract boolean isArray() throws FmcException
Indicates whether the container element is an array.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o isLeaf
 public abstract boolean isLeaf() throws FmcException
Indicates whether the container element is a leaf.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o isStruct
 public abstract 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.
 o leafCount
 public abstract 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.
 o leaves
 public abstract ContainerElement[] leaves() throws FmcException
Returns all leaf elements of the container element.

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o name
 public abstract String name() throws FmcException
Returns the name of the container element.

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

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o getBuffer
 public abstract 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.
 o getBuffer2
 public abstract 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.
 o getDouble
 public abstract 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.
 o getDouble2
 public abstract 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.
 o getElement
 public abstract ContainerElement getElement(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.
 o getLong
 public abstract int getLong() throws FmcException
 o getLong2
 public abstract 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.
 o getString
 public abstract 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.
 o getString2
 public abstract 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index