wt.clients.prodmgmt
Class ReferencesList

java.lang.Object
  extended byjava.util.AbstractCollection
      extended byjava.util.AbstractList
          extended byjava.util.Vector
              extended bywt.clients.prodmgmt.ReferencesList
All Implemented Interfaces:
Cloneable, Collection, List, RandomAccess, Serializable

public class ReferencesList
extends Vector

ReferencesList is a list of the references for a PartItem. It allows adding and removed referenced documents from the list.

Supported API: false

Extendable: false

See Also:
PartItem, Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.util.AbstractList
 
Field Summary
protected  Vector addedReference
           
protected  boolean frameStarted
           
protected  PartItem part
           
protected  Vector removedReference
           
 
Fields inherited from class java.util.Vector
capacityIncrement, elementCount, elementData
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
ReferencesList(PartItem part)
          Constructs a ReferenceList using the specified PartItem.
 
Method Summary
 void addElementDoc(DocumentItem references)
          Adds the DocumentItem to the ReferencesList
 ReferenceItem elementAt(String identity)
          Returns the ReferenceItem with the specified identity.
 void endFrame()
          End the current frame to keep track of added and removed references.
protected  void populate()
          Populate the list using the contained PartItem.
 void removeElementAt(String identity)
          Remove the ReferenceItem with the specified identity.
 boolean saveFrame()
          Saves all changes made since the last beginFrame.
 void startFrame()
          Start a new frame to keep track of added and removed references.
 String[] toMultiList()
          Returns an array of Strings representing the ReferencesList, formatted for use in a symantec.itools.awt.MultiList.
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Field Detail

frameStarted

protected boolean frameStarted

removedReference

protected Vector removedReference

addedReference

protected Vector addedReference

part

protected PartItem part
Constructor Detail

ReferencesList

public ReferencesList(PartItem part)
Constructs a ReferenceList using the specified PartItem.

Parameters:
part - the PartItem to hold References for
Method Detail

saveFrame

public boolean saveFrame()
                  throws WTException
Saves all changes made since the last beginFrame.

Returns:
true if the ReferencesList was modified since the last save
Throws:
WTException - if an error occurs saving the list.

startFrame

public void startFrame()
Start a new frame to keep track of added and removed references.


endFrame

public void endFrame()
End the current frame to keep track of added and removed references.


elementAt

public ReferenceItem elementAt(String identity)
Returns the ReferenceItem with the specified identity.

Parameters:
identity - the identity of the requested ReferenceItem.
Returns:
the ReferenceItem with the specified identity.

addElementDoc

public void addElementDoc(DocumentItem references)
Adds the DocumentItem to the ReferencesList

Parameters:
references - the new DocumentItem to reference

removeElementAt

public void removeElementAt(String identity)
Remove the ReferenceItem with the specified identity.

Parameters:
identity - the identity of the requested ReferenceItem.
Returns:
the ReferenceItem with the specified identity.

populate

protected void populate()
Populate the list using the contained PartItem.


toMultiList

public String[] toMultiList()
Returns an array of Strings representing the ReferencesList, formatted for use in a symantec.itools.awt.MultiList. Each string has the identity of the referenceItem and its businessType.

Returns:
a String array representation of the ReferencesList