public class TdbTermList extends java.lang.Object implements java.lang.Iterable<TdbTerm>, com.tietoenator.trip.jxp.internal.utils.DOMSink
The TdbTermList class is from version 3.0 of TRIPjxp no longer a subclass of java.util.Vector<E>. Applications that use TdbTermList may therefore have to be modified.
Constructor and Description |
---|
TdbTermList()
Creates an empty term list instance.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears the retrieved terms from the TdbTermList object.
|
void |
close()
Releases server-side resources associated wih this term list and invalidates
it.
|
TdbTerm |
get(int index)
Returns a TdbTerm instance for the term at the specified index.
|
java.lang.String |
getCommand()
Get the CCL command that generated this term list
|
boolean |
isEmpty()
Returns true if there are no terms in this term list.
|
boolean |
isOnDemand()
Returns true if the term list values are retrieved from the server on
demand (value is true), or if the entire term list is retrieved in one
go up front (value is false).
|
boolean |
isValid()
Returns true if the term list is valid for use.
|
java.util.Iterator<TdbTerm> |
iterator()
Returns an iterator over the terms in this term list.
|
int |
size()
Returns the total number of terms associated with this term list.
|
TdbTerm[] |
toArray()
Returns the entire term list as an array.
|
public int size()
public boolean isEmpty()
public boolean isValid()
public boolean isOnDemand()
On-demand retrieval requires TRIPsystem 7.0 or later.
On-demand term lists can also be used concurrently; an application can have multiple TdbTermList instances active at the same time, based on different DISPLAY order results.
public java.lang.String getCommand()
public java.util.Iterator<TdbTerm> iterator()
iterator
in interface java.lang.Iterable<TdbTerm>
public TdbTerm[] toArray() throws TdbException
TdbException
- If the terms could not be returnedTdbTermList.get(int)
,
TdbTermList.iterator()
public void clear()
public void close()
public TdbTerm get(int index) throws TdbException
index
- The zero-based index of the term in the term list.TdbException
- If the term could not be returned