com.ibm.commerce.me.datatype

Class SessionInfo

  • java.lang.Object
    • com.ibm.commerce.me.datatype.SessionInfo
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable


    public class SessionInfo
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Cloneable
    This class stores information for a session.
    See Also:
    Serialized Form
    • Field Summary

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

      Constructors 
      Constructor and Description
      SessionInfo()
      The SessionInfo constructor calls its parents constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      TypedProperty getCustomSessionProperties()
      This method gets custom session properties.
      java.lang.String getDeptName()
      This method gets the requisitioner's department name.
      long getItemId()
      This method gets the item ID (for 'display LogonMode').
      short getLogonMode()
      This method gets the logon mode of the session info.
      java.lang.String getOrderStatusUrl()
      This method gets the order status URL.
      java.lang.String getPostBackURL()
      This method gets the postback URL.
      java.lang.String getProcurementProtocolId()
      This method gets the Procurement Protocol ID name.
      java.lang.String getReqId()
      This method gets the requisitioner ID.
      java.lang.String getReqName()
      This method gets the requisitioner name.
      java.lang.String getSessionId()
      This method gets the session ID.
      java.lang.String getSessionType()
      This method gets the type of the session info.
      long getShoppingCartId()
      This method gets the shopping cart ID of the session info.
      void setCustomSessionProperties(TypedProperty sessionProperties)
      This method sets custom session properties.
      void setDeptName(java.lang.String aDeptName)
      This method sets the name of the department to which the requisitioner belongs.
      void setItemId(long anItemId)
      This method sets the item ID (for 'display' LogonMode).
      void setLogonMode(short aLogonMode)
      This method sets the logon type.
      void setOrderStatusUrl(java.lang.String anOrderStatusUrl)
      This method sets the order status URL.
      void setPostBackURL(java.lang.String newPostBackURL)
      This method sets the postback URL.
      void setProcurementProtocolId(java.lang.String protocolId)
      This method sets the Procurement Protocol ID.
      void setReqId(java.lang.String newReqId)
      This method sets the requisitioner ID.
      void setReqName(java.lang.String newReqName)
      This method sets the requisitioner name.
      void setSessionId(java.lang.String newSessionId)
      This method sets the session ID.
      void setSessionType(java.lang.String newSessionType)
      This method sets the type of the session info.
      void setShoppingCartId(long aShoppingCartId)
      This method sets the shopping cart ID.
      java.lang.String toString()
      This method returns a String that represents the value of this object.
      • 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 field
        See Also:
        Constant Field Values
    • Constructor Detail

      • SessionInfo

        public SessionInfo()
        The SessionInfo constructor calls its parents constructor.
    • Method Detail

      • getCustomSessionProperties

        public TypedProperty getCustomSessionProperties()
        This method gets custom session properties.
        Returns:
        a set of name-value pairs containing custom session attributes
      • getDeptName

        public java.lang.String getDeptName()
        This method gets the requisitioner's department name.
        Returns:
        the department name
      • getItemId

        public long getItemId()
        This method gets the item ID (for 'display LogonMode').
        Returns:
        the item ID
      • getLogonMode

        public short getLogonMode()
        This method gets the logon mode of the session info.
        Returns:
        the logon mode for this session
      • getOrderStatusUrl

        public java.lang.String getOrderStatusUrl()
        This method gets the order status URL.
        Returns:
        URL to which this order status should be posted
      • getPostBackURL

        public java.lang.String getPostBackURL()
        This method gets the postback URL.
        Returns:
        URL to post this order approval
      • getProcurementProtocolId

        public java.lang.String getProcurementProtocolId()
        This method gets the Procurement Protocol ID name.
        Returns:
        the procurement protocol ID
      • getReqId

        public java.lang.String getReqId()
        This method gets the requisitioner ID.
        Returns:
        the requisitioner ID
      • getReqName

        public java.lang.String getReqName()
        This method gets the requisitioner name.
        Returns:
        the name of the requisitioner
      • getSessionId

        public java.lang.String getSessionId()
        This method gets the session ID.
        Returns:
        the session ID
      • getSessionType

        public java.lang.String getSessionType()
        This method gets the type of the session info.
        Returns:
        the session info type
      • getShoppingCartId

        public long getShoppingCartId()
        This method gets the shopping cart ID of the session info.
        Returns:
        the shopping cart ID inside this session
      • setCustomSessionProperties

        public void setCustomSessionProperties(TypedProperty sessionProperties)
        This method sets custom session properties.
        Parameters:
        sessionProperties - a set of name-value pairs containing custom session attributes
      • setDeptName

        public void setDeptName(java.lang.String aDeptName)
        This method sets the name of the department to which the requisitioner belongs.
        Parameters:
        aDeptName - the new name of the department
      • setItemId

        public void setItemId(long anItemId)
        This method sets the item ID (for 'display' LogonMode).
        Parameters:
        anItemId - the new item ID
      • setLogonMode

        public void setLogonMode(short aLogonMode)
        This method sets the logon type.
        Parameters:
        aLogonMode - the new logon type
      • setOrderStatusUrl

        public void setOrderStatusUrl(java.lang.String anOrderStatusUrl)
        This method sets the order status URL.
        Parameters:
        anOrderStatusUrl - URL to post this order status
      • setPostBackURL

        public void setPostBackURL(java.lang.String newPostBackURL)
        This method sets the postback URL.
        Parameters:
        newPostBackURL - URL to post this order approval
      • setProcurementProtocolId

        public void setProcurementProtocolId(java.lang.String protocolId)
        This method sets the Procurement Protocol ID.
        Parameters:
        protocolId - The new protocol ID
      • setReqId

        public void setReqId(java.lang.String newReqId)
        This method sets the requisitioner ID.
        Parameters:
        newReqId - the new ID for the requisitioner
      • setReqName

        public void setReqName(java.lang.String newReqName)
        This method sets the requisitioner name.
        Parameters:
        newReqName - the name of the requisitioner
      • setSessionId

        public void setSessionId(java.lang.String newSessionId)
        This method sets the session ID.
        Parameters:
        newSessionId - the session ID of the current session
      • setSessionType

        public void setSessionType(java.lang.String newSessionType)
        This method sets the type of the session info.
        Parameters:
        newSessionType - the type of this session
      • setShoppingCartId

        public void setShoppingCartId(long aShoppingCartId)
        This method sets the shopping cart ID.
        Parameters:
        aShoppingCartId - the new shopping cart ID
      • toString

        public java.lang.String toString()
        This method returns a String that represents the value of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the session info