com.ibm.commerce.component.bod

Class DataArea

  • java.lang.Object
    • com.ibm.commerce.component.bod.DataArea
  • All Implemented Interfaces:
    java.io.Serializable


    public class DataArea
    extends java.lang.Object
    implements java.io.Serializable
    The DataArea is a container inside of a BusinessObjectDocument. It contains a verb and several nouns. The verb describes the actions to be performed on the nouns.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      DataArea()
      Default constructor
      DataArea(Verb verb, java.lang.Object[] theNouns)
      Create the DataArea with a Verb and one or more Nouns
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addNoun(java.lang.Object noun)
      Adds a single noun to the DataArea
      java.util.List getNouns()
      Returns a List of Nouns in the DataArea
      java.lang.Object[] getNounsArray() 
      static java.lang.String getNounsRootName() 
      Verb getVerb()
      Returns the Verb in the DataArea
      void setNouns(java.util.List pNouns)
      Sets the list of nouns contained in this data area
      void setNounsArray(java.lang.Object[] pNouns)
      A way to add 1 or more verbs to the DataArea
      void setVerb(Verb verb)
      Sets the Verb in the DataArea
      java.lang.String toString() 
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DataArea

        public DataArea()
        Default constructor
      • DataArea

        public DataArea(Verb verb,
                        java.lang.Object[] theNouns)
        Create the DataArea with a Verb and one or more Nouns
        Parameters:
        verb -
        theNouns -
    • Method Detail

      • getVerb

        public Verb getVerb()
        Returns the Verb in the DataArea
        Returns:
        Verb
      • setVerb

        public void setVerb(Verb verb)
        Sets the Verb in the DataArea
        Parameters:
        verb -
      • getNouns

        public java.util.List getNouns()
        Returns a List of Nouns in the DataArea
        Returns:
        Nouns
      • setNounsArray

        public void setNounsArray(java.lang.Object[] pNouns)
        A way to add 1 or more verbs to the DataArea
        Parameters:
        nouns -
      • setNouns

        public void setNouns(java.util.List pNouns)
        Sets the list of nouns contained in this data area
        Parameters:
        nouns - the list of nouns to be set
      • addNoun

        public void addNoun(java.lang.Object noun)
        Adds a single noun to the DataArea
        Parameters:
        noun -
      • getNounsArray

        public java.lang.Object[] getNounsArray()
        Returns:
        an array of Nouns
      • getNounsRootName

        public static java.lang.String getNounsRootName()
        Returns:
        the root of a VerbPath if the context of the path is an instance of DataArea
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation of this data area