com.ibm.commerce.component.contextservice

Class ActivityDataNameValuePairs

  • java.lang.Object
    • com.ibm.commerce.component.contextservice.ActivityDataNameValuePairs
  • All Implemented Interfaces:
    java.io.Serializable


    public class ActivityDataNameValuePairs
    extends java.lang.Object
    implements java.io.Serializable
    Represents the parameter set required to initialize an activity to be used in incoming Web service calls. Analogous to ActivityData but implemented with an array of name-value pairs as per Web service requirements.
    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
      ActivityDataNameValuePairs()
      The do-nothing zero-argument constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      NameValuePair[] getNVPs()
      Gets the complete parameter set.
      NameValuePair getNVPs(int index)
      Gets the name-value pair at a given index.
      boolean isTemporary()
      Checks whether the token to be created using this activity data is temporary.
      void setNVPs(int index, NameValuePair pair)
      Sets the name-value pair at a given index.
      void setNVPs(NameValuePair[] pairs)
      Sets the complete parameter set.
      void setTemporary(boolean bool)
      Sets whether the token to be created using this activity data is temporary.
      com.ibm.commerce.component.contextservice.ActivityData toActivityData()
      Converts the parameter set from an array of name-value pairs into an ActivityData object.
      java.util.Map toMap()
      Converts the parameter set from an array of name-value pairs into a map.
      • Methods inherited from class java.lang.Object

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

      • COPYRIGHT

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

      • ActivityDataNameValuePairs

        public ActivityDataNameValuePairs()
        The do-nothing zero-argument constructor.
    • Method Detail

      • getNVPs

        public NameValuePair[] getNVPs()
        Gets the complete parameter set.
        Returns:
        the parameter set as an array of name-value pairs
      • setNVPs

        public void setNVPs(NameValuePair[] pairs)
        Sets the complete parameter set.
        Parameters:
        pairs - the parameter set as an array of name-value pairs
      • getNVPs

        public NameValuePair getNVPs(int index)
        Gets the name-value pair at a given index.
        Parameters:
        the - index
        Returns:
        the name-value pair
      • setNVPs

        public void setNVPs(int index,
                            NameValuePair pair)
        Sets the name-value pair at a given index.
        Parameters:
        the - index
        pair - the name-value pair
      • toMap

        public java.util.Map toMap()
        Converts the parameter set from an array of name-value pairs into a map.
        Returns:
        the parameter set as a map
      • toActivityData

        public com.ibm.commerce.component.contextservice.ActivityData toActivityData()
        Converts the parameter set from an array of name-value pairs into an ActivityData object.
        Returns:
        the parameter set as an ActivityData object
      • setTemporary

        public void setTemporary(boolean bool)
        Sets whether the token to be created using this activity data is temporary. If the token is marked as temporary, no record in the CTXMGMT table or any of its associated CTXDATA will be created.
        Parameters:
        bool - true for temporary; false otherwise
      • isTemporary

        public boolean isTemporary()
        Checks whether the token to be created using this activity data is temporary.
        Returns:
        true if the token is temporary; false otherwise