All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.ContainerElement
- public interface ContainerElement
- Version:
- 3.2.0.2
-
arrayElements()
- Returns the array
elements of the container element.
-
cardinality()
- Returns the number of
array elements of the container element.
-
fullName()
- Returns the fully-qualified
dotted name of the container element.
-
getBuffer()
- Returns the value of the
specified container element leaf element in Java.
-
getBuffer2(int)
- Returns the value of the
specified container element leaf element in Java.
-
getDouble()
- Returns the value of the
specified container element leaf element in Java.
-
getDouble2(int)
- Returns the value of the
specified container element leaf element in Java.
-
getElement(String)
- Provides access to an
element of the container element.
-
getLong()
-
-
getLong2(int)
- Returns the value of the
specified container element leaf element in Java.
-
getString()
- Returns the value of the
specified container element leaf element in Java.
-
getString2(int)
- Returns the value of the
specified container element leaf element in Java.
-
isArray()
- Indicates whether the
container element is an array.
-
isEmpty()
- Indicates whether no
container element information is available.
-
isLeaf()
- Indicates whether the
container element is a leaf.
-
isStruct()
- Indicates whether the
container element is a structure itself.
-
leafCount()
- Returns the number of leaf
elements of the container element.
-
leaves()
- Returns all leaf elements of
the container element.
-
memberCount()
- Returns the number of
structural members in the container element.
-
name()
- Returns the name of the
container element.
-
structMembers()
- Returns the structural
members of the container element.
-
type()
- Returns the type of the
container element, that is, the data structure name.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
getLong
public abstract int getLong() throws FmcException
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.
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.
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