com.ibm.commerce.contract.beans

Class ContractDataBean

  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, ContractInputDataBean, ContractSmartDataBean, com.ibm.commerce.security.Delegator, com.ibm.commerce.security.Protectable, java.io.Serializable

    public class ContractDataBean
extends ContractDataBeanBase
implements ContractInputDataBean, ContractSmartDataBean
    This data bean represents a contract object. A contract represents the terms and conditions that apply to a transaction.

    Prerequisite parameters:
  • WCSReferenceNumber: the contract id


    • It is used when getting the contract data from the database.
    This data bean maps to the CONTRACT database table.
See Also:
Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The IBM copyright notice field.

      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString

    • Constructor Summary

      Constructors 
      Constructor and Description
      ContractDataBean() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.command.CommandContext getCommandContext()
      Gets the command context set within this bean.
      java.lang.String getDataBeanKeyReferenceNumber()
      Gets the contract ID.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Gets the request property set within this bean.
      void populate()
      Loads data into the data bean when the DataBeanManager.activate() runs.
      void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
      Sets the command context within this bean.
      void setDataBeanKeyReferenceNumber(java.lang.String aReferenceNumber)
      Sets the contract ID.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
      Sets the request property within this bean.

      • Methods inherited from class com.ibm.commerce.contract.objects.ContractAccessBean

        addToStore, createNewVersion, findActiveContractByFamilyId, findActiveContractByFamilyIdNoCache, findActiveContractByNameOwnerAndOrigin, findActiveContractByNameOwnerAndOriginNoCache, findAll, findByNameOwnerAndOrigin, findByNameOwnerAndOriginNoCache, findByNameOwnerOriginAndState, findByNameOwnerOriginAndStateNoCache, findByNameOwnerOriginAndVersion, findByNameOwnerOriginAndVersionNoCache, findByOwnerId, findByParticipantId, findByState, findClosableContractByNameOwnerAndOrigin, findContractWithLargestMinorByNameOwnerOriginAndMajorVersion, fulfills, getAccountId, getComments, getContractLevelParticipants, getContractsReferringToContractId, getDescription, getDescription, getEntity, getFamilyId, getFamilyIdInEntityType, getMajorVersion, getMajorVersionInEntityType, getMarkForDelete, getMarkForDeleteInEntityType, getMinorVersion, getMinorVersionInEntityType, getName, getOrigin, getOriginInEntityType, getOwner, getOwnerReferenceNumber, getOwnerReferenceNumberInEntityType, getReferenceNumber, getReferenceNumberInEntityType, getReferredTradingAgreementId, getState, getStateInEntityType, getStoreXMLDefinition, getStoreXMLString, getTCs, getTCsByTCSubType, getTCsByTCSubTypeWithoutTCParticipant, getTCsByTCType, getTCsByTCTypeWithoutTCParticipant, getTimeActivated, getTimeActivatedInEntityType, getTimeApproved, getTimeApprovedInEntityType, getTimeCreated, getTimeCreatedInEntityType, getTimeDeployed, getTimeDeployedInEntityType, getTimeUpdated, getTimeUpdatedInEntityType, getUsage, getUsageInEntityType, getXMLByTradingIdAndType, instantiateEntity, setAccountId, setComments, setFamilyId, setFamilyId, setInitKey_referenceNumber, setInitKey_referenceNumber, setMajorVersion, setMajorVersion, setMarkForDelete, setMarkForDelete, setMinorVersion, setMinorVersion, setName, setOrigin, setOrigin, setOwnerReferenceNumber, setOwnerReferenceNumber, setReferenceNumber, setReferenceNumber, setReferredTradingAgreementId, setState, setState, setStoreXMLDefinition, setStoreXMLDefinition, setTimeActivated, setTimeActivated, setTimeApproved, setTimeApproved, setTimeCreated, setTimeCreated, setTimeDeployed, setTimeDeployed, setTimeUpdated, setTimeUpdated, setUsage, setUsage

      • Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

        createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

      • 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
        The IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ContractDataBean

        public ContractDataBean()

    • Method Detail

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Gets the command context set within this bean.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        The command context set within this bean.

      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Gets the request property set within this bean.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        The request property set within this bean.

      • populate

        public void populate()
        Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception - The java.lang.Exception exception.

      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
        Sets the command context within this bean.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        aCommandContext - The command context set within this bean.

      • setDataBeanKeyReferenceNumber

        public void setDataBeanKeyReferenceNumber(java.lang.String aReferenceNumber)
        Sets the contract ID.
        Specified by:
        setDataBeanKeyReferenceNumber in interface ContractInputDataBean
        Parameters:
        aReferenceNumber - The contract ID.

      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
        Sets the request property within this bean.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        aRequestProperty - The request property set within this bean.