atg.commerce.order
Class PaymentGroupOrderRelationship

java.lang.Object
  extended by atg.commerce.order.CommerceIdentifierImpl
      extended by atg.commerce.order.PaymentGroupOrderRelationship
All Implemented Interfaces:
ChangedProperties, CommerceIdentifier, OrderRelationship, PaymentGroupRelationship, Relationship, java.io.Serializable, java.util.Observer

public class PaymentGroupOrderRelationship
extends CommerceIdentifierImpl
implements OrderRelationship, PaymentGroupRelationship, ChangedProperties

An object which represents a relationship between an Order and a PaymentGroup. The valid relationship types are OrderAmount, OrderAmountRemaining, TaxAmount, and TaxAmountRemaining. OrderAmount specifies a specific amount of the entire cost of an Order which is assigned to the PaymentGroup in the Relationship. OrderAmountRemaining specifies the amount of the Order which has not been assigned to any PaymentGroup be assigned to the PaymentGroup in the Relationship. TaxAmount specifies a specific amount of the tax of an Order which is assigned to the PaymentGroup in the Relationship. TaxAmountRemaining specifies the amount of the tax of an Order which has not been assigned to any PaymentGroup be assigned to the PaymentGroup in the Relationship.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
PaymentGroupOrderRelationship()
           
 
Method Summary
 void addChangedProperty(java.lang.String pPropertyName)
          Adds a changedProperty
 void clearChangedProperties()
          Clears the changedProperties List
 double getAmount()
          Returns the amount that this relationship represents
 java.util.Set getChangedProperties()
          Returns the changedProperties
 Order getOrder()
          Returns the order
 PaymentGroup getPaymentGroup()
          Returns the PaymentGroup reference.
 java.lang.Object getPropertyValue(java.lang.String pPropertyName)
          Returns a property value
 java.lang.String getRelationshipClassType()
          Returns the relationshipClassType
 int getRelationshipType()
          Returns the Relationship type.
 java.lang.String getRelationshipTypeAsString()
          Returns the Relationship type as a String.
 MutableRepositoryItem getRepositoryItem()
          Returns the repositoryItem
 boolean getSaveAllProperties()
          Returns the saveAllProperties
 boolean isChanged()
          Returns the isChanged flag
 void setAmount(double pAmount)
          Sets the amount that this relationship represents
 void setChanged(boolean pChanged)
          Marks this object as changed
 void setOrder(Order pOrder)
          Sets the order
 void setPaymentGroup(PaymentGroup pGroup)
          Sets the PaymentGroup reference.
 void setPropertyValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue)
          Sets a property value
 void setRelationshipClassType(java.lang.String pRelationshipClassType)
          Sets the relationshipClassType
 void setRelationshipType(int pType)
          Set the Relationship type.
 void setRelationshipTypeAsString(java.lang.String pType)
          Set the Relationship type as a String.
 void setRepositoryItem(MutableRepositoryItem pRepositoryItem)
          Sets the repositoryItem
 void setSaveAllProperties(boolean pSaveAllProperties)
          Sets the saveAllProperties
 void update(java.util.Observable o, java.lang.Object arg)
          This method is called whenever a property in a contained object changes and the containing object needs to be notified.
 
Methods inherited from class atg.commerce.order.CommerceIdentifierImpl
getId, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface atg.commerce.order.CommerceIdentifier
getId
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

PaymentGroupOrderRelationship

public PaymentGroupOrderRelationship()
Method Detail

getRelationshipClassType

public java.lang.String getRelationshipClassType()
Returns the relationshipClassType

Specified by:
getRelationshipClassType in interface Relationship

setRelationshipClassType

public void setRelationshipClassType(java.lang.String pRelationshipClassType)
Sets the relationshipClassType

Specified by:
setRelationshipClassType in interface Relationship

getRelationshipType

public int getRelationshipType()
Returns the Relationship type.

Specified by:
getRelationshipType in interface Relationship

setRelationshipType

public void setRelationshipType(int pType)
                         throws InvalidTypeException
Set the Relationship type.

Specified by:
setRelationshipType in interface Relationship
Throws:
InvalidTypeException

getRelationshipTypeAsString

public java.lang.String getRelationshipTypeAsString()
Returns the Relationship type as a String.


setRelationshipTypeAsString

public void setRelationshipTypeAsString(java.lang.String pType)
                                 throws InvalidTypeException
Set the Relationship type as a String.

Throws:
InvalidTypeException

getPaymentGroup

public PaymentGroup getPaymentGroup()
Returns the PaymentGroup reference.

Specified by:
getPaymentGroup in interface PaymentGroupRelationship

setPaymentGroup

public void setPaymentGroup(PaymentGroup pGroup)
Sets the PaymentGroup reference.

Specified by:
setPaymentGroup in interface PaymentGroupRelationship

getOrder

public Order getOrder()
Returns the order

Specified by:
getOrder in interface OrderRelationship

setOrder

public void setOrder(Order pOrder)
Sets the order

Specified by:
setOrder in interface OrderRelationship

getAmount

public double getAmount()
Returns the amount that this relationship represents

Specified by:
getAmount in interface OrderRelationship
Specified by:
getAmount in interface PaymentGroupRelationship

setAmount

public void setAmount(double pAmount)
Sets the amount that this relationship represents

Specified by:
setAmount in interface OrderRelationship
Specified by:
setAmount in interface PaymentGroupRelationship

update

public void update(java.util.Observable o,
                   java.lang.Object arg)
This method is called whenever a property in a contained object changes and the containing object needs to be notified.

Specified by:
update in interface java.util.Observer
Parameters:
o - the object which changed
arg - the name of the property which changed

getSaveAllProperties

public boolean getSaveAllProperties()
Returns the saveAllProperties

Specified by:
getSaveAllProperties in interface ChangedProperties

setSaveAllProperties

public void setSaveAllProperties(boolean pSaveAllProperties)
Sets the saveAllProperties

Specified by:
setSaveAllProperties in interface ChangedProperties

isChanged

public boolean isChanged()
Returns the isChanged flag

Specified by:
isChanged in interface ChangedProperties

setChanged

public void setChanged(boolean pChanged)
Marks this object as changed

Specified by:
setChanged in interface ChangedProperties

getChangedProperties

public java.util.Set getChangedProperties()
Returns the changedProperties

Specified by:
getChangedProperties in interface ChangedProperties

addChangedProperty

public void addChangedProperty(java.lang.String pPropertyName)
Adds a changedProperty

Specified by:
addChangedProperty in interface ChangedProperties

clearChangedProperties

public void clearChangedProperties()
Clears the changedProperties List

Specified by:
clearChangedProperties in interface ChangedProperties

getRepositoryItem

public MutableRepositoryItem getRepositoryItem()
Returns the repositoryItem

Specified by:
getRepositoryItem in interface ChangedProperties

setRepositoryItem

public void setRepositoryItem(MutableRepositoryItem pRepositoryItem)
Sets the repositoryItem

Specified by:
setRepositoryItem in interface ChangedProperties

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String pPropertyName)
Returns a property value

Specified by:
getPropertyValue in interface ChangedProperties
Returns:
returns a property value

setPropertyValue

public void setPropertyValue(java.lang.String pPropertyName,
                             java.lang.Object pPropertyValue)
Sets a property value

Specified by:
setPropertyValue in interface ChangedProperties
Parameters:
pPropertyValue - the value to set for the given property value