AR System Java API

com.bmc.arsys.api
Class StatusHistoryValue

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList<StatusHistoryItem>
              extended by com.bmc.arsys.api.StatusHistoryValue
All Implemented Interfaces:
Serializable, Cloneable, Iterable<StatusHistoryItem>, Collection<StatusHistoryItem>, List<StatusHistoryItem>, RandomAccess

public class StatusHistoryValue
extends ArrayList<StatusHistoryItem>
implements Cloneable, Serializable

The StatusHistoryValue class is used to represent the values of status history fields. The StatusHistoryValue class is a collection of StatusHistoryItem objects. It contains a string representation of all the StatusHistoryItem objects in encoded form. The list of StatusHistory objects can be retrieved using the decode method from the StatusHistory class.

Each entry in the Status History field includes the name of the person who made the change and the timestamp in which the change occurred.

See Also:
Serialized Form

Field Summary
static String AR_DEFN_STATUS_HISTORYCOMMA
           
static String AR_DEFN_STATUS_HISTORYSEP
           
 
Constructor Summary
StatusHistoryValue()
           
 
Method Summary
 Object clone()
          Clone implementation that returns an Object with data cloned from self
static StatusHistoryValue decode(String encoded)
          Takes the formatted string returned for all diary fields and decodes it into an array of diary entries.
 String encode()
          Encodes the current StatusHistory into an encoded diary string.
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Field Detail

AR_DEFN_STATUS_HISTORYSEP

public static final String AR_DEFN_STATUS_HISTORYSEP

AR_DEFN_STATUS_HISTORYCOMMA

public static final String AR_DEFN_STATUS_HISTORYCOMMA
Constructor Detail

StatusHistoryValue

public StatusHistoryValue()
Method Detail

decode

public static StatusHistoryValue decode(String encoded)
                                 throws ARException
Takes the formatted string returned for all diary fields and decodes it into an array of diary entries.

Throws:
NullPointerException - if invalid ARServerUser object
ARException - if diary information is not decoded

encode

public String encode()
Encodes the current StatusHistory into an encoded diary string.

Returns:
a populated String

clone

public Object clone()
Clone implementation that returns an Object with data cloned from self

Overrides:
clone in class ArrayList<StatusHistoryItem>

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.