com.ibm.commerce.payment.ppc.beans

Class PPCListPIsForOrderDataBean

java.lang.Object

com.ibm.commerce.payment.ppc.beans.PPCListPIsForOrderDataBean

All Implemented Interfaces:

CommandDataBean, DataBean, InputDataBean, java.io.Serializable

public class PPCListPIsForOrderDataBean
extends java.lang.Object
implements CommandDataBean, InputDataBean

This databean gets list of the payment instruction information for a specified order from PPCListPIsForOrderCmd databean command.

See Also:

PPCListPIsForOrderCmd, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright

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

emptyString

Constructor Summary

Constructors

Constructor and Description
PPCListPIsForOrderDataBean()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandInterfaceName() This method returns the databean command interface name of this databean, and through the databean command, the data of this databean are populated.
int	getListSize() This method returns the size of the list, which means the number of PaymentInstruction objects for the specified order.
java.lang.String	getOrderId() This method returns the current order ID.
java.util.ArrayList	getPaymentInstructionList() This method returns the payment instructions as an ArrayList object for a specified order.
PaymentInstruction	getPIListData(int index) This method returns the PaymentInstruction object from the ArrayList by index.
TypedProperty	getRequestProperties() This method returns the parameters as TypedProperty passed as part of the URL.
java.lang.String	getStoreId() This method returns the current store ID.
void	setCommandInterfaceName(java.lang.String ifname) This method sets the databean command interface name of this databean, and through the databean command, the data of this databean are populated.
void	setOrderId(java.lang.String orderId) This method sets the current order ID.
void	setPaymentInstructionList(java.util.ArrayList paramPaymentInstructionList) This method sets the payment instructions as an ArrayList object for a specified order.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the passed parameters as part of the URL if any.
void	setStoreId(java.lang.String string) This method sets the current store ID.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright

See Also:

Constant Field Values

Constructor Detail

PPCListPIsForOrderDataBean

public PPCListPIsForOrderDataBean()

Method Detail

getCommandInterfaceName

public java.lang.String getCommandInterfaceName()

This method returns the databean command interface name of this databean, and through the databean command, the data of this databean are populated. The default command interface is PPCListPIsForOrderCmd.

Specified by:

getCommandInterfaceName in interface CommandDataBean

Returns:

The databean command interface name of this databean

setCommandInterfaceName

public void setCommandInterfaceName(java.lang.String ifname)

This method sets the databean command interface name of this databean, and through the databean command, the data of this databean are populated.

Specified by:

setCommandInterfaceName in interface CommandDataBean

Parameters:

ifname - The databean command interface name of this databean

getPaymentInstructionList

public java.util.ArrayList getPaymentInstructionList()

This method returns the payment instructions as an ArrayList object for a specified order.

Returns:

paymentInstructionList The payment instructions as an ArrayList object for a specified order

setPaymentInstructionList

public void setPaymentInstructionList(java.util.ArrayList paramPaymentInstructionList)

This method sets the payment instructions as an ArrayList object for a specified order.

Parameters:

paramPaymentInstructionList - The payment instructions as an ArrayList object for a specified order

setOrderId

public void setOrderId(java.lang.String orderId)

This method sets the current order ID.

Parameters:

orderId - The current order ID

getOrderId

public java.lang.String getOrderId()

This method returns the current order ID.

Returns:

orderID The current order ID

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)

This method sets the passed parameters as part of the URL if any.

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

aRequestProperties - The parameters are set into the request properties

getRequestProperties

public TypedProperty getRequestProperties()

This method returns the parameters as TypedProperty passed as part of the URL.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

TypedProperty The parameters as TypedProperty passed as part of the URL

getPIListData

public PaymentInstruction getPIListData(int index)
                                 throws java.lang.ArrayIndexOutOfBoundsException

This method returns the PaymentInstruction object from the ArrayList by index.

Parameters:

index - Position the current payment instruction locates in

Returns:

PaymentInstruction The payment instruction from the ArrayList by index

Throws:

java.lang.ArrayIndexOutOfBoundsException - In case of any array index out of bounds

getListSize

public int getListSize()

This method returns the size of the list, which means the number of PaymentInstruction objects for the specified order.

Returns:

The size of the list

getStoreId

public java.lang.String getStoreId()

This method returns the current store ID.

Returns:

storeId The current store ID

setStoreId

public void setStoreId(java.lang.String string)

This method sets the current store ID.

Parameters:

string - The current store ID