com.ibm.commerce.adapter
Class GenericSessionData

java.lang.Object
  |
  +--com.ibm.commerce.adapter.GenericSessionData
All Implemented Interfaces:
SessionData

public class GenericSessionData
extends java.lang.Object
implements SessionData

Reserved for IBM internal use. This class hold the Commerce Server session specific data without any adapter specifics.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
Constructor Summary
GenericSessionData()
          Reserved for IBM internal use.
GenericSessionData( GenericSessionData sessionData)
          Reserved for IBM internal use.
 
Method Summary
 boolean equals( GenericSessionData sessionData)
          Reserved for IBM internal use.
 java.lang.String getCurrencyId()
          Reserved for IBM internal use.
 java.lang.String getCurrentContracts()
          Reserved for IBM internal use.
 java.lang.Integer getCurrentLanguageId()
          Reserved for IBM internal use.
 java.lang.String getEligibleContracts()
          Reserved for IBM internal use.
 java.lang.String getEncCurContr()
          Reserved for IBM internal use.
 java.lang.String getEncElgContr()
          Reserved for IBM internal use.
 java.lang.String getEncParOrg()
          Reserved for IBM internal use.
 java.lang.String getEncSesContr()
          Reserved for IBM internal use.
 java.lang.Integer getLanguageId()
          Reserved for IBM internal use.
 java.lang.String getParentOrganization()
          Reserved for IBM internal use.
 java.lang.Integer getPredictionPosition()
          Reserved for IBM internal use.
 java.lang.String getSessionContracts()
          Reserved for IBM internal use.
 java.lang.Integer getStoreId()
          Reserved for IBM internal use.
 java.lang.Long getUserId()
          Reserved for IBM internal use.
 boolean isChanged()
          Reserved for IBM internal use.
 void setChanged(boolean newChanged)
          Reserved for IBM internal use.
 void setCurrencyId(java.lang.String strCurrencyId)
          Reserved for IBM internal use.
 void setCurrentContracts(java.lang.String value)
          Reserved for IBM internal use.
 void setCurrentLanguageId(java.lang.Integer inCurrentLanguageId)
          Reserved for IBM internal use.
 void setEligibleContracts(java.lang.String value)
          Reserved for IBM internal use.
 void setEncCurContr(java.lang.String newIstrEncCurContr)
          Reserved for IBM internal use.
 void setEncElgContr(java.lang.String newIstrEncElgContr)
          Reserved for IBM internal use.
 void setEncParOrg(java.lang.String newIstrEncParOrg)
          Reserved for IBM internal use.
 void setEncSesContr(java.lang.String newIstrEncSesContr)
          Reserved for IBM internal use.
 void setLanguageId(java.lang.Integer nLanguageId)
          Reserved for IBM internal use.
 void setParentOrganization(java.lang.String value)
          Reserved for IBM internal use.
 void setPredictionPosition(java.lang.Integer iPredictionPos)
          Reserved for IBM internal use.
 void setSessionContracts(java.lang.String value)
          Reserved for IBM internal use.
 void setStoreId(java.lang.Integer nStoreId)
          Reserved for IBM internal use.
 void setUserId(java.lang.Long nUserId)
          Reserved for IBM internal use.
 java.lang.String toString()
          Reserved for IBM internal use.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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

GenericSessionData

public GenericSessionData()
Reserved for IBM internal use. Creates the default session data object. Whether to enable cookie tracing is enabled when this object is created.

GenericSessionData

public GenericSessionData(GenericSessionData sessionData)
Reserved for IBM internal use. Creates the default session data object based on the given session data. First is performs what the empty constructor and then sets the currency, language, store, user, parent organization, eligible contracts, current contracts and session contracts based on the values found in the given session data.
Method Detail

equals

public boolean equals(GenericSessionData sessionData)
Reserved for IBM internal use. Returns true if current Session data object matches the specified one. The fields of the session data that is compared are the user identifier, store identifier, language identifier, currency identifier, eligble contracts, parent organization, session contracts, and current contracts. If any of these values differ, false will be returned.
Parameters:
sessionData - The session data to compare.
Returns:
Whether the specified session data is equal to the current session data.

getCurrencyId

public java.lang.String getCurrencyId()
Reserved for IBM internal use. Gets the currency identifier.
Specified by:
getCurrencyId in interface SessionData
Returns:
The currency identifier.

getEncCurContr

public java.lang.String getEncCurContr()
Reserved for IBM internal use. Gets the encyrpted version current contracts.
Returns:
Always will return null.

getEncElgContr

public java.lang.String getEncElgContr()
Reserved for IBM internal use. Gets the encrypted version of the eligible contracts.
Returns:
Always will return null.

getEncParOrg

public java.lang.String getEncParOrg()
Reserved for IBM internal use. Gets the encrypted version of the session owner's parent organization.
Returns:
Always will return null.

getEncSesContr

public java.lang.String getEncSesContr()
Reserved for IBM internal use. Gets the encrypted version of the session contracts.
Returns:
Always will return null.

getLanguageId

public java.lang.Integer getLanguageId()
Reserved for IBM internal use. Gets the language identifier.
Specified by:
getLanguageId in interface SessionData
Returns:
The language identifier.

getPredictionPosition

public java.lang.Integer getPredictionPosition()
Reserved for IBM internal use. Gets the prediction position.
Returns:
The predition position.

getStoreId

public java.lang.Integer getStoreId()
Reserved for IBM internal use. Gets the store identifier.
Specified by:
getStoreId in interface SessionData
Returns:
The store identifier.

getUserId

public java.lang.Long getUserId()
Reserved for IBM internal use. Gets the user identifier.
Specified by:
getUserId in interface SessionData
Returns:
The user identifier.

isChanged

public boolean isChanged()
Reserved for IBM internal use. Gets whether the session data has changed to ensure no unneccessary data is written.
Returns:
Whether the session data has changed.

setChanged

public void setChanged(boolean newChanged)
Reserved for IBM internal use. Sets the changed flag of the session data to indicate that the session data has changed so it will be written at the end of the request.
Parameters:
newChanged - whether the session data has changed or not.

setCurrencyId

public void setCurrencyId(java.lang.String strCurrencyId)
Reserved for IBM internal use. Sets the currency identifier and sets the changed flag to indicate that the session data has changed.
Specified by:
setCurrencyId in interface SessionData
Parameters:
strCurrencyId - the currency identifier.

setEncCurContr

public void setEncCurContr(java.lang.String newIstrEncCurContr)
Reserved for IBM internal use. Sets the encrypted current contracts. This method does not store the data.
Parameters:
newIstrEncCurContr - the encyrpted current contracts.

setEncElgContr

public void setEncElgContr(java.lang.String newIstrEncElgContr)
Reserved for IBM internal use. Sets the encrypted eligible contracts. This method does not store the data.

setEncParOrg

public void setEncParOrg(java.lang.String newIstrEncParOrg)
Reserved for IBM internal use. Sets the encrypted parent organization. This method does not store the data.

setEncSesContr

public void setEncSesContr(java.lang.String newIstrEncSesContr)
Reserved for IBM internal use. Sets the encrypted session contracts. This method does not store the data.

setLanguageId

public void setLanguageId(java.lang.Integer nLanguageId)
Reserved for IBM internal use. Sets the language identifier and changes the changed flag to ensure the session data will be committed.
Specified by:
setLanguageId in interface SessionData
Parameters:
nLanguageId - the language identifier.

setPredictionPosition

public void setPredictionPosition(java.lang.Integer iPredictionPos)
Reserved for IBM internal use. Sets the prediction position and changes the changed flag to ensure that session data will be committed.

setStoreId

public void setStoreId(java.lang.Integer nStoreId)
Reserved for IBM internal use. Sets the store identifier and changes the changed flag to ensure the session data will be committed.
Specified by:
setStoreId in interface SessionData
Parameters:
nStoreId - the store identifier.

setUserId

public void setUserId(java.lang.Long nUserId)
Reserved for IBM internal use. Sets the user identifier and changes the changed flag to ensure the session data will be committed.
Specified by:
setUserId in interface SessionData
Parameters:
nUserId - the user identifier.

toString

public java.lang.String toString()
Reserved for IBM internal use. Generate the string representation of the object.
Overrides:
toString in class java.lang.Object
Returns:
The string representation of the object.

getCurrentContracts

public java.lang.String getCurrentContracts()
Reserved for IBM internal use. Gets the current contracts.
Specified by:
getCurrentContracts in interface SessionData
Returns:
The current contracts.

getEligibleContracts

public java.lang.String getEligibleContracts()
Reserved for IBM internal use. Gets the eligible contracts.
Specified by:
getEligibleContracts in interface SessionData
Returns:
The eligible contracts.

getSessionContracts

public java.lang.String getSessionContracts()
Reserved for IBM internal use. Gets the session contracts.
Specified by:
getSessionContracts in interface SessionData
Returns:
The session contracts.

getParentOrganization

public java.lang.String getParentOrganization()
Reserved for IBM internal use. Gets the session owner's parent organization.
Specified by:
getParentOrganization in interface SessionData
Returns:
The parent organization.

setCurrentContracts

public void setCurrentContracts(java.lang.String value)
Reserved for IBM internal use. Sets the current contracts and changes the changed flag to ensure the session data will be committed.
Specified by:
setCurrentContracts in interface SessionData
Parameters:
value - The current contracts.

setEligibleContracts

public void setEligibleContracts(java.lang.String value)
Reserved for IBM internal use. Sets the eligible contracts and changes the changed flag to ensure the session data will be committed.
Specified by:
setEligibleContracts in interface SessionData
Parameters:
value - the eligible contracts.

setSessionContracts

public void setSessionContracts(java.lang.String value)
Reserved for IBM internal use. Sets the session contracts and changes the changed flag to ensure the session data will be committed.
Specified by:
setSessionContracts in interface SessionData
Parameters:
value - the session contracts.

setParentOrganization

public void setParentOrganization(java.lang.String value)
Reserved for IBM internal use. Sets the session owner's parent organization and changes the changed flag to ensure the session data will be committed.
Specified by:
setParentOrganization in interface SessionData
Parameters:
value - the parent organization.

getCurrentLanguageId

public java.lang.Integer getCurrentLanguageId()
Reserved for IBM internal use. Gets the current language identifier.
Returns:
The language identifier.

setCurrentLanguageId

public void setCurrentLanguageId(java.lang.Integer inCurrentLanguageId)
Reserved for IBM internal use. Sets the current language identifier.