com.ibm.commerce.contract.objimpl
Class PaymentTCBeanBase

java.lang.Object
  |
  +--com.ibm.commerce.base.objects.ECEntityBean
        |
        +--com.ibm.commerce.contract.objimpl.TermConditionBeanBase
              |
              +--com.ibm.commerce.contract.objects.TermConditionBean
                    |
                    +--com.ibm.commerce.contract.objimpl.PaymentTCBeanBase
Direct Known Subclasses:
PaymentTCBean

public class PaymentTCBeanBase
extends TermConditionBean

This bean provides access to the TERMCOND table.

The following is a description of this table:

This table contains terms and conditions used in trading agreements (business accounts, contracts, RFQs). To see how columns are used by different terms and conditions, refer to TERMCOND column mapping in the online help.

See Also:
Serialized Form

Field Summary
 java.lang.Long memberId
           
 java.lang.String nickName
           
 
Fields inherited from class com.ibm.commerce.contract.objimpl. TermConditionBeanBase
changeableFlag, isDTD, mandatoryFlag, referenceNumber, tcSequence, timeCreated, timeUpdated, tradingId
 
Constructor Summary
PaymentTCBeanBase()
           
 
Method Summary
 java.lang.Long createNewVersion(java.lang.Long argNewTradingId)
          This method creates a new version of the terms and conditions.
 com.ibm.commerce.contract.objects.TermConditionKey ejbCreate(java.lang.Long argTradingId, org.w3c.dom.Element argElement)
          Constructs a PaymentTCAccessBean object with the specified trading agreement ID, and the payment term condition element.
 void ejbPostCreate(java.lang.Long argTradingId, org.w3c.dom.Element argElement)
          Parses the XML element to construct the terms and conditions.
 java.lang.String getDisplayName()
          This method provides access to the TERMCOND.STRINGFIELD1 column of DB2 type VARCHAR(3200) NULL.
 java.lang.Long getMemberId()
          This method provides access to the TERMCOND.BIGINTFIELD1 column of DB2 type BIGINT NULL.
 java.lang.String getNickName()
          This method provides access to the TERMCOND.STRINGFIELD2 column of DB2 type VARCHAR(254) NULL.
 PAttrValueAccessBean[] getPAttrValues()
          The method returns an array of PAttrValueAccessBeans representing all the attribute values that the term condition has.
 java.lang.String getXMLString()
          This method retrieves the XML String associated with the terms and conditions.
 java.lang.String getXMLString(boolean tcdata)
          This method retrieves the XML String associated with the terms and conditions.
 void parseXMLElement(org.w3c.dom.Element argElement)
          This method parses the given XML element.
 void setDisplayName(java.lang.String newValue)
          This method provides access to the TERMCOND.STRINGFIELD1 column of DB2 type VARCHAR(3200) NULL.
 void setMemberId(java.lang.Long newMemberId)
          This method provides access to the TERMCOND.BIGINTFIELD1 column of DB2 type BIGINT NULL.
 void setNickName(java.lang.String newNickName)
          This method provides access to the TERMCOND.STRINGFIELD2 column of DB2 type VARCHAR(254) NULL.
 
Methods inherited from class com.ibm.commerce.contract.objects. TermConditionBean
_copyFromEJB, _copyToEJB, _getLinks, _initLinks, _removeLinks, ejbActivate, ejbLoad, ejbPassivate, ejbRemove, ejbStore
 
Methods inherited from class com.ibm.commerce.contract.objimpl. TermConditionBeanBase
addProductSetAdjustment, deleteProductSetAdjustment, findProductSetIdsByTCIdAndType, getChangeableFlag, getDescription, getDescription, getEntireCatalogAdjustment, getEntireCatalogSelected, getExclusionProductSets, getFallbackDescription, getInclusionProductSets, getMandatoryFlag, getParticipants, getPolicies, getPoliciesByType, getPolicyNameForElementPolicyReference, getPriceListId, getPriceListIds, getProductSetAdjustments, getProductSetId, getReferenceNumber, getStoreIdentityForElementPolicyReference, getStoreOwnerForElementPolicyReference, getTcSequence, getTcSubType, getTimeCreated, getTimeUpdated, getTradingId, getXMLDefinitions, getXMLStringForElementPolicyReference, getXMLStringForTCData, getXMLStrings, markForDelete, parseElementPolicyReference, retrieveBeanName, setChangeableFlag, setEntireCatalogAdjustment, setEntireCatalogAdjustment, setEntireCatalogSelected, setEntireCatalogSelected, setMandatoryFlag, setPriceListId, setProductSetId, setReferenceNumber, setTcSequence, setTimeCreated, setTimeUpdated, setTradingId, setXMLDefinition, setXMLDefinition, updateProductSetAdjustment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

nickName

public java.lang.String nickName

memberId

public java.lang.Long memberId
Constructor Detail

PaymentTCBeanBase

public PaymentTCBeanBase()
Method Detail

createNewVersion

public java.lang.Long createNewVersion(java.lang.Long argNewTradingId)
                                throws javax.ejb.CreateException,
                                       javax.ejb.FinderException,
                                       javax.naming.NamingException,
                                       javax.ejb.RemoveException,
                                       org.xml.sax.SAXException,
                                       java.io.IOException
This method creates a new version of the terms and conditions.
Overrides:
createNewVersion in class TermConditionBeanBase
Parameters:
argNewTradingId - The trading ID of the new contract version.
Returns:
The term condition ID of the new contract version.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.
javax.ejb.RemoveException - The javax.ejb.RemoveException exception.
org.xml.sax.SAXException - The org.xml.sax.SAXException exception.
java.io.IOException - The java.io.IOException exception.

ejbCreate

public com.ibm.commerce.contract.objects.TermConditionKey ejbCreate(java.lang.Long argTradingId,
                                                                    org.w3c.dom.Element argElement)
                                                             throws javax.ejb.CreateException,
                                                                    javax.ejb.FinderException,
                                                                    javax.naming.NamingException,
                                                                    javax.ejb.RemoveException
Constructs a PaymentTCAccessBean object with the specified trading agreement ID, and the payment term condition element.
Overrides:
ejbCreate in class TermConditionBean
Parameters:
argTradingId - The ID of the trading agreement the terms and conditions will be associated with.
argElement - The XML Elment object represeting the terms and conditions.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.
javax.ejb.RemoveException - The javax.ejb.RemoveException exception.
See Also:
TermConditionBeanBase.ejbCreate(Long, Element)

ejbPostCreate

public void ejbPostCreate(java.lang.Long argTradingId,
                          org.w3c.dom.Element argElement)
                   throws javax.ejb.CreateException,
                          javax.ejb.FinderException,
                          javax.naming.NamingException,
                          javax.ejb.RemoveException
Parses the XML element to construct the terms and conditions.
Overrides:
ejbPostCreate in class TermConditionBean
Parameters:
argTradingId - The ID of the trading agreement the terms and conditions will be associated with.
argElement - The XML Elment object representing the terms and conditions.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.
javax.ejb.RemoveException - The javax.ejb.RemoveException exception.

getDisplayName

public java.lang.String getDisplayName()

This method provides access to the TERMCOND.STRINGFIELD1 column of DB2 type VARCHAR(3200) NULL.

The following is a description of this column:

A STRING field used to store terms and conditions data.

Returns:
The displayed name of the payment terms and conditions.

getMemberId

public java.lang.Long getMemberId()

This method provides access to the TERMCOND.BIGINTFIELD1 column of DB2 type BIGINT NULL.

The following is a description of this column:

A BIGINT field used to store terms and conditions data.

Returns:
The ID of the member who does the payment.

getNickName

public java.lang.String getNickName()

This method provides access to the TERMCOND.STRINGFIELD2 column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A STRING field used to store terms and conditions data.

Returns:
The nickname of the member who does the payment.

getPAttrValues

public PAttrValueAccessBean[] getPAttrValues()
                                      throws javax.ejb.CreateException,
                                             javax.ejb.FinderException,
                                             javax.naming.NamingException
The method returns an array of PAttrValueAccessBeans representing all the attribute values that the term condition has.
Returns:
An array of PAttrValueAccessBeans representing all the attribute values that the term condition has.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

getXMLString

public java.lang.String getXMLString()
                              throws javax.ejb.CreateException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

This method retrieves the XML String associated with the terms and conditions.

No terms and conditions data will be included in this XML String.

Overrides:
getXMLString in class TermConditionBeanBase
Returns:
The String object representing the terms and conditions in XML Element format.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

getXMLString

public java.lang.String getXMLString(boolean tcdata)
                              throws javax.ejb.CreateException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException
This method retrieves the XML String associated with the terms and conditions.
Overrides:
getXMLString in class TermConditionBeanBase
Parameters:
tcdata - The flag indicating whether terms and conditions data should be included.
Returns:
The String object representing the terms and conditions in XML Element format.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

parseXMLElement

public void parseXMLElement(org.w3c.dom.Element argElement)
                     throws javax.ejb.CreateException,
                            javax.ejb.FinderException,
                            javax.naming.NamingException,
                            javax.ejb.RemoveException
This method parses the given XML element.
Overrides:
parseXMLElement in class TermConditionBeanBase
Parameters:
argElement - The XML element associated with the terms and conditions.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.
javax.ejb.RemoveException - The javax.ejb.RemoveException exception.

setDisplayName

public void setDisplayName(java.lang.String newValue)

This method provides access to the TERMCOND.STRINGFIELD1 column of DB2 type VARCHAR(3200) NULL.

The following is a description of this column:

A STRING field used to store terms and conditions data.

Parameters:
newValue - The displayed name of the payment terms and conditions.

setMemberId

public void setMemberId(java.lang.Long newMemberId)

This method provides access to the TERMCOND.BIGINTFIELD1 column of DB2 type BIGINT NULL.

The following is a description of this column:

A BIGINT field used to store terms and conditions data.

Parameters:
newMemberId - The ID of the member who does the payment.

setNickName

public void setNickName(java.lang.String newNickName)

This method provides access to the TERMCOND.STRINGFIELD2 column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A STRING field used to store terms and conditions data.

Parameters:
newNickName - The nickname of the member who does the payment.