AEDPTickler

java.lang.Object
- com.ibm.commerce.edp.tickler.AEDPTickler

All Implemented Interfaces:

IEDPTickler

Direct Known Subclasses:

EDPTicklerDefault, EDPTicklerWasLog, EDPTicklerWC
```
public abstract class AEDPTickler
extends java.lang.Object
implements IEDPTickler
```
This is the base abstract tickler class of Payment Rules, which is used to simplify other concrete tickler class implementation.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

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

Constructor Summary

Constructors
Constructor and Description

AEDPTickler()

Constructors
Constructor and Description
`AEDPTickler()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComments(java.lang.String oneComment)` This method adds a comment for current tickler.
`CommandContext`	`getCommandContext()` This method returns the command context of the command where the tickler is sent.
`java.lang.String[]`	`getComments()` This mehtod returns the comments of current tickler.
`javax.swing.AbstractAction`	`getEDPAction()` This method sets the current Payment Rules action decided by the payment rules configuration.
`java.lang.Long`	`getEDPOrderId()` This method returns the current EDPOrder ID involved in current tickler.
`java.lang.Long`	`getEDPPaymentInstructionId()` This method returns the ID of payment instruction in Payment Rules involved in current tickler.
`java.util.Locale`	`getLocale()` This method returns the locale information from the command context.
`java.lang.Long`	`getOrderId()` This method returns the order identifier in order system, Note that it is different from `EDPOrderId`.
`java.lang.String`	`getReason()` The method returns current reason that causes this tickler to create.
`java.lang.String`	`getReasonCode()` This method returns the reason code of the reason that causes this tickler to crreate.
`java.lang.Integer`	`getStoreId()` This method returns the identifier of store this order belongs to in order system.
`abstract void`	`sendTickler()` This method sents the tickler after it is created, which is abstract and must be implemented by the sub class.
`void`	`setCommandContext(CommandContext context)` This method sets the command context of the command where the tickler is sent.
`void`	`setComments(java.util.Collection collection)` This mehtod sets the comments of current tickler.
`void`	`setComments(java.lang.String[] cmts)` This method sets the comments of current tickler.
`void`	`setEDPAction(javax.swing.AbstractAction pedpAction)` This method sets the current Payment Rules action decided by the payment rules configuration.
`void`	`setEDPOrderId(java.lang.Long aedpOrderId)` This method sets the current EDPOrder ID involved in current tickler.
`void`	`setEDPPaymentInstructionId(java.lang.Long id)` This method sets the ID of payment instruction in Payment Rules involved in current tickler.
`void`	`setLocale(java.util.Locale _locale)` This method sets the current locale information.
`void`	`setOrderId(java.lang.Long aorderId)` This method sets the order identifier in order system.
`void`	`setReason(java.lang.String preason)` The method sets current reason that causes this tickler to create.
`void`	`setReasonCode(java.lang.String preasonCode)` This method sets the reason code of the reason that causes this tickler to crreate.
`void`	`setStoreId(java.lang.Integer astoreId)` This method sets the identifier of store this order belongs to in order system.
`java.lang.String`	`toString()` This method returns a readable form of the edp tickler object.

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
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AEDPTickler
```
public AEDPTickler()
```
- Method Detail
  - getComments
```
public java.lang.String[] getComments()
```
    This mehtod returns the comments of current tickler.
    
    Specified by:
    
    getComments in interface IEDPTickler
    
    Returns:
    
    strComments The returned comments as a String array.
  - setEDPAction
```
public void setEDPAction(javax.swing.AbstractAction pedpAction)
```
    This method sets the current Payment Rules action decided by the payment rules configuration.
    
    Specified by:
    
    setEDPAction in interface IEDPTickler
    
    Parameters:
    
    pedpAction - Current Payment Rules action
  - getEDPAction
```
public javax.swing.AbstractAction getEDPAction()
```
    This method sets the current Payment Rules action decided by the payment rules configuration.
    
    Specified by:
    
    getEDPAction in interface IEDPTickler
    
    Returns:
    
    edpAction Current Payment Rules action
  - setReason
```
public void setReason(java.lang.String preason)
```
    The method sets current reason that causes this tickler to create.
    
    Specified by:
    
    setReason in interface IEDPTickler
    
    Parameters:
    
    preason - Current reason that causes this tickler to create
  - getReason
```
public java.lang.String getReason()
```
    The method returns current reason that causes this tickler to create.
    
    Specified by:
    
    getReason in interface IEDPTickler
    
    Returns:
    
    reason Current reason that causes this tickler to create
  - setReasonCode
```
public void setReasonCode(java.lang.String preasonCode)
```
    This method sets the reason code of the reason that causes this tickler to crreate.
    
    Specified by:
    
    setReasonCode in interface IEDPTickler
    
    Parameters:
    
    preasonCode - The reason code of the reason that causes this tickler to crreate
  - getReasonCode
```
public java.lang.String getReasonCode()
```
    This method returns the reason code of the reason that causes this tickler to crreate.
    
    Specified by:
    
    getReasonCode in interface IEDPTickler
    
    Returns:
    
    reasonCode The reason code of the reason that causes this tickler to crreate
  - addComments
```
public void addComments(java.lang.String oneComment)
```
    This method adds a comment for current tickler.
    
    Specified by:
    
    addComments in interface IEDPTickler
    
    Parameters:
    
    oneComment - The comment to add
  - sendTickler
```
public abstract void sendTickler()
```
    This method sents the tickler after it is created, which is abstract and must be implemented by the sub class.
    
    Specified by:
    
    sendTickler in interface IEDPTickler
  - setEDPOrderId
```
public void setEDPOrderId(java.lang.Long aedpOrderId)
```
    This method sets the current EDPOrder ID involved in current tickler.
    
    Specified by:
    
    setEDPOrderId in interface IEDPTickler
    
    Parameters:
    
    aedpOrderId - The current EDPOrder ID
  - getEDPOrderId
```
public java.lang.Long getEDPOrderId()
```
    This method returns the current EDPOrder ID involved in current tickler.
    
    Specified by:
    
    getEDPOrderId in interface IEDPTickler
    
    Returns:
    
    edpOrderId The current EDPOrder ID
  - setEDPPaymentInstructionId
```
public void setEDPPaymentInstructionId(java.lang.Long id)
```
    This method sets the ID of payment instruction in Payment Rules involved in current tickler.
    
    Specified by:
    
    setEDPPaymentInstructionId in interface IEDPTickler
    
    Parameters:
    
    id - The ID of payment instruction in Payment Rules
  - getEDPPaymentInstructionId
```
public java.lang.Long getEDPPaymentInstructionId()
```
    This method returns the ID of payment instruction in Payment Rules involved in current tickler.
    
    Specified by:
    
    getEDPPaymentInstructionId in interface IEDPTickler
    
    Returns:
    
    edpPaymentInstructionId The ID of payment instruction in Payment Rules
  - toString
```
public java.lang.String toString()
```
    This method returns a readable form of the edp tickler object.
    
    Warning: not localized, for debugging purposes only!
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string format of the Payment Rules tickler object.
  - getOrderId
```
public java.lang.Long getOrderId()
```
    Description copied from interface: IEDPTickler
    
    This method returns the order identifier in order system, Note that it is different from EDPOrderId.
    
    Specified by:
    
    getOrderId in interface IEDPTickler
    
    Returns:
    
    A Long object represents the order identifier in order system
    
    See Also:
    
    IEDPTickler.getOrderId()
  - getStoreId
```
public java.lang.Integer getStoreId()
```
    Description copied from interface: IEDPTickler
    
    This method returns the identifier of store this order belongs to in order system.
    
    Specified by:
    
    getStoreId in interface IEDPTickler
    
    Returns:
    
    An Integer Object ID of a store
    
    See Also:
    
    IEDPTickler.getStoreId()
  - setOrderId
```
public void setOrderId(java.lang.Long aorderId)
```
    Description copied from interface: IEDPTickler
    
    This method sets the order identifier in order system. Note that it is different from EDPOrderId.
    
    Specified by:
    
    setOrderId in interface IEDPTickler
    
    Parameters:
    
    aorderId - The order ID in order system
    
    See Also:
    
    IEDPTickler.setOrderId(java.lang.Long)
  - setStoreId
```
public void setStoreId(java.lang.Integer astoreId)
```
    Description copied from interface: IEDPTickler
    
    This method sets the identifier of store this order belongs to in order system.
    
    Specified by:
    
    setStoreId in interface IEDPTickler
    
    Parameters:
    
    astoreId - The store ID this order belongs to in order system
    
    See Also:
    
    IEDPTickler.setStoreId(Integer)
  - setComments
```
public void setComments(java.util.Collection collection)
```
    This mehtod sets the comments of current tickler.
    
    Parameters:
    
    collection - The comments of current tickler to set as a collection
  - setComments
```
public void setComments(java.lang.String[] cmts)
```
    This method sets the comments of current tickler.
    
    Specified by:
    
    setComments in interface IEDPTickler
    
    Parameters:
    
    cmts - The comments of current tickler to set as a String array
  - getCommandContext
```
public CommandContext getCommandContext()
```
    This method returns the command context of the command where the tickler is sent.
    
    Specified by:
    
    getCommandContext in interface IEDPTickler
    
    Returns:
    
    commandContext The command context of the command where the tickler is sent
  - setCommandContext
```
public void setCommandContext(CommandContext context)
```
    This method sets the command context of the command where the tickler is sent.
    
    Specified by:
    
    setCommandContext in interface IEDPTickler
    
    Parameters:
    
    context - The command context of the command where the tickler is sent
  - getLocale
```
public java.util.Locale getLocale()
```
    This method returns the locale information from the command context.
    
    Returns:
    
    The current locale information
  - setLocale
```
public void setLocale(java.util.Locale _locale)
```
    This method sets the current locale information.
    
    Parameters:
    
    _locale - The current locale information

Methods inherited from class java.lang.Object

COPYRIGHT

AEDPTickler

getComments

setEDPAction

getEDPAction

setReason

getReason

setReasonCode

getReasonCode

addComments

sendTickler

setEDPOrderId

getEDPOrderId

setEDPPaymentInstructionId

getEDPPaymentInstructionId

toString

getOrderId

getStoreId

setOrderId

setStoreId

setComments

setComments

getCommandContext

setCommandContext

getLocale

setLocale