com.ibm.commerce.contract.objimpl
Class PriceTCMasterCatalogWithFilteringBeanBase

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.PriceTCMasterCatalogWithFilteringBeanBase
Direct Known Subclasses:
PriceTCMasterCatalogWithFilteringBean

public class PriceTCMasterCatalogWithFilteringBeanBase
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
static java.lang.String COPYRIGHT
           
 java.lang.Integer deployStatus
           
 java.sql.Timestamp deployTimeStamp
           
 java.lang.Double entireCatalogAdjustment
           
 java.lang.Integer entireCatalogSelected
           
 java.lang.Long priceListId
           
 
Fields inherited from class com.ibm.commerce.contract.objimpl. TermConditionBeanBase
changeableFlag, isDTD, mandatoryFlag, referenceNumber, tcSequence, timeCreated, timeUpdated, tradingId
 
Constructor Summary
PriceTCMasterCatalogWithFilteringBeanBase()
           
 
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 PriceTCMasterCatalogWithFilteringAccessBean object with the specified trading agreement ID, and the price 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 getAttributeValue(java.lang.String properties, java.lang.String attributeKey)
          Gets the attribute value from a properties string.
 java.lang.Integer getDeployStatus()
          This method provides access to the TERMCOND.INTEGERFIELD2 column of DB2 type INTEGER NULL.
 java.sql.Timestamp getDeployTimeStamp()
          This method provides access to the TERMCOND.TIMEFIELD1 column of DB2 type TIMESTAMP NULL.
 java.lang.Double getEntireCatalogAdjustment()
          This method provides access to the TERMCOND.FLOATFIELD1 column of DB2 type DOUBLE NULL.
 java.lang.Integer getEntireCatalogSelected()
          This method provides access to the TERMCOND.INTEGERFIELD1 column of DB2 type INTEGER NULL.
 java.lang.Integer[] getExclusionProductSets()
          Gets an array of exclusion product sets based on the term condition ID.
 java.lang.Integer[] getInclusionProductSets()
          Gets an array of inclusion product sets based on the term condition ID.
 java.lang.Long getPriceListId()
          This method provides access to the TERMCOND.BIGINTFIELD1 column of DB2 type BIGINT NULL.
 java.lang.Long[] getPriceListIds()
          Retrieves an array of price list IDs associated with the price policy.
 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 setDeployStatus(java.lang.Integer deployStatus)
          This method provides access to the TERMCOND.INTEGERFIELD2 column of DB2 type INTEGER NULL.
 void setDeployStatus(java.lang.String deployStatus)
          This method provides access to the TERMCOND.INTEGERFIELD2 column of DB2 type INTEGER NULL.
 void setDeployTimeStamp(java.lang.String deployTimeStamp)
          This method provides access to the TERMCOND.TIMEFIELD1 column of DB2 type TIMESTAMP NULL.
 void setDeployTimeStamp(java.sql.Timestamp deployTimeStamp)
          This method provides access to the TERMCOND.TIMEFIELD1 column of DB2 type TIMESTAMP NULL.
 void setEntireCatalogAdjustment(java.lang.Double entireCatalogAdjustment)
          This method provides access to the TERMCOND.FLOATFIELD1 column of DB2 type DOUBLE NULL.
 void setEntireCatalogAdjustment(java.lang.String entireCatalogAdjustment)
          This method provides access to the TERMCOND.FLOATFIELD1 column of DB2 type DOUBLE NULL.
 void setEntireCatalogSelected(java.lang.Integer entireCatalogSelected)
          This method provides access to the TERMCOND.INTEGERFIELD1 column of DB2 type INTEGER NULL.
 void setEntireCatalogSelected(java.lang.String entireCatalogSelected)
          This method provides access to the TERMCOND.INTEGERFIELD1 column of DB2 type INTEGER NULL.
 void setPriceListId(java.lang.Long argPriceListId)
          This method provides access to the TERMCOND.BIGINTFIELD1 column of DB2 type BIGINT 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, getFallbackDescription, getMandatoryFlag, getParticipants, getPolicies, getPoliciesByType, getPolicyNameForElementPolicyReference, getProductSetAdjustments, getProductSetId, getReferenceNumber, getStoreIdentityForElementPolicyReference, getStoreOwnerForElementPolicyReference, getTcSequence, getTcSubType, getTimeCreated, getTimeUpdated, getTradingId, getXMLDefinitions, getXMLStringForElementPolicyReference, getXMLStringForTCData, getXMLStrings, markForDelete, parseElementPolicyReference, retrieveBeanName, setChangeableFlag, setMandatoryFlag, 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

entireCatalogSelected

public java.lang.Integer entireCatalogSelected

entireCatalogAdjustment

public java.lang.Double entireCatalogAdjustment

deployTimeStamp

public java.sql.Timestamp deployTimeStamp

deployStatus

public java.lang.Integer deployStatus

priceListId

public java.lang.Long priceListId

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

PriceTCMasterCatalogWithFilteringBeanBase

public PriceTCMasterCatalogWithFilteringBeanBase()
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 PriceTCMasterCatalogWithFilteringAccessBean object with the specified trading agreement ID, and the price 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.

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.

getEntireCatalogAdjustment

public java.lang.Double getEntireCatalogAdjustment()

This method provides access to the TERMCOND.FLOATFIELD1 column of DB2 type DOUBLE NULL.

The following is a description of this column:

A DOUBLE field used to store terms and conditions data.

Overrides:
getEntireCatalogAdjustment in class TermConditionBeanBase
Returns:
The adjustment percentage of the entire catalog.

setEntireCatalogAdjustment

public void setEntireCatalogAdjustment(java.lang.Double entireCatalogAdjustment)

This method provides access to the TERMCOND.FLOATFIELD1 column of DB2 type DOUBLE NULL.

The following is a description of this column:

A DOUBLE field used to store terms and conditions data.

Overrides:
setEntireCatalogAdjustment in class TermConditionBeanBase
Parameters:
entireCatalogAdjustment - The adjustment percentage of the entire catalog.

setEntireCatalogAdjustment

public void setEntireCatalogAdjustment(java.lang.String entireCatalogAdjustment)

This method provides access to the TERMCOND.FLOATFIELD1 column of DB2 type DOUBLE NULL.

The following is a description of this column:

A DOUBLE field used to store terms and conditions data.

Overrides:
setEntireCatalogAdjustment in class TermConditionBeanBase
Parameters:
entireCatalogAdjustment - The adjustment percentage of the entire catalog.

getEntireCatalogSelected

public java.lang.Integer getEntireCatalogSelected()

This method provides access to the TERMCOND.INTEGERFIELD1 column of DB2 type INTEGER NULL.

The following is a description of this column:

An INTEGER field used to store terms and conditions data.

Overrides:
getEntireCatalogSelected in class TermConditionBeanBase
Returns:
A flag indicating whether the entire catalog is selected.

setEntireCatalogSelected

public void setEntireCatalogSelected(java.lang.Integer entireCatalogSelected)

This method provides access to the TERMCOND.INTEGERFIELD1 column of DB2 type INTEGER NULL.

The following is a description of this column:

An INTEGER field used to store terms and conditions data.

Overrides:
setEntireCatalogSelected in class TermConditionBeanBase
Parameters:
entireCatalogSelected - A flag indicating whether the entire catalog is selected.

setEntireCatalogSelected

public void setEntireCatalogSelected(java.lang.String entireCatalogSelected)

This method provides access to the TERMCOND.INTEGERFIELD1 column of DB2 type INTEGER NULL.

The following is a description of this column:

An INTEGER field used to store terms and conditions data.

Overrides:
setEntireCatalogSelected in class TermConditionBeanBase
Parameters:
entireCatalogSelected - A flag indicating whether the entire catalog is selected.

getInclusionProductSets

public java.lang.Integer[] getInclusionProductSets()
                                            throws javax.naming.NamingException,
                                                   javax.ejb.CreateException,
                                                   java.sql.SQLException
Gets an array of inclusion product sets based on the term condition ID.
Overrides:
getInclusionProductSets in class TermConditionBeanBase
Returns:
An array of inclusion product sets.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.
java.sql.SQLException - The java.sql.SQLException exception.

getExclusionProductSets

public java.lang.Integer[] getExclusionProductSets()
                                            throws javax.naming.NamingException,
                                                   javax.ejb.CreateException,
                                                   java.sql.SQLException
Gets an array of exclusion product sets based on the term condition ID.
Overrides:
getExclusionProductSets in class TermConditionBeanBase
Returns:
An array of exclusion product sets.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.
java.sql.SQLException - The java.sql.SQLException exception.

getDeployTimeStamp

public java.sql.Timestamp getDeployTimeStamp()

This method provides access to the TERMCOND.TIMEFIELD1 column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

A TIMESTAMP field used to store terms and conditions data.

Returns:
The time of deployment.

setDeployTimeStamp

public void setDeployTimeStamp(java.sql.Timestamp deployTimeStamp)

This method provides access to the TERMCOND.TIMEFIELD1 column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

A TIMESTAMP field used to store terms and conditions data.

Parameters:
deployTimeStamp - The time of deployment.

setDeployTimeStamp

public void setDeployTimeStamp(java.lang.String deployTimeStamp)

This method provides access to the TERMCOND.TIMEFIELD1 column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

A TIMESTAMP field used to store terms and conditions data.

Parameters:
deployTimeStamp - The time of deployment.

getDeployStatus

public java.lang.Integer getDeployStatus()

This method provides access to the TERMCOND.INTEGERFIELD2 column of DB2 type INTEGER NULL.

The following is a description of this column:

An INTEGER field used to store terms and conditions data.

Returns:
The status of the deployment.

setDeployStatus

public void setDeployStatus(java.lang.Integer deployStatus)

This method provides access to the TERMCOND.INTEGERFIELD2 column of DB2 type INTEGER NULL.

The following is a description of this column:

An INTEGER field used to store terms and conditions data.

Parameters:
deployStatus - The status of the deployment.

setDeployStatus

public void setDeployStatus(java.lang.String deployStatus)

This method provides access to the TERMCOND.INTEGERFIELD2 column of DB2 type INTEGER NULL.

The following is a description of this column:

An INTEGER field used to store terms and conditions data.

Parameters:
deployStatus - The status of the deployment.

getPriceListId

public java.lang.Long getPriceListId()

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.

Overrides:
getPriceListId in class TermConditionBeanBase
Returns:
The ID of the price list.

setPriceListId

public void setPriceListId(java.lang.Long argPriceListId)

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.

Overrides:
setPriceListId in class TermConditionBeanBase
Parameters:
argPriceListId - The ID of the price list.

getPriceListIds

public java.lang.Long[] getPriceListIds()
                                 throws javax.ejb.CreateException,
                                        javax.naming.NamingException,
                                        javax.ejb.FinderException

Retrieves an array of price list IDs associated with the price policy.

If getPriceListId is not null, then return getPriceListId, if it is null, then read the POLICYTC table, get the policies, find the trading position container from the policy properties field, and return the price list ids.

Overrides:
getPriceListIds in class TermConditionBeanBase
Returns:
An array of price list IDs.
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.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String properties,
                                          java.lang.String attributeKey)
Gets the attribute value from a properties string.
Parameters:
properties - The entire properties string.
attributeKey - The attribute key corresponding to the name of the name/value pair
Returns:
The attribute value corresponding to the value of the name/value pair