com.ibm.commerce.payment.ppc.beans

Class PPCListCreditsForPIDataBean

java.lang.Object

com.ibm.commerce.payment.ppc.beans.PPCListCreditsForPIDataBean

All Implemented Interfaces:

CommandDataBean, DataBean, InputDataBean, java.io.Serializable

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

This databean gets list of the credit information for a specified payment instruction from PPCListCreditsForPICmd databean command.

See Also:

PPCListCreditsForPICmd, 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
PPCListCreditsForPIDataBean()

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.
Credit	getCreditListData(int index) This method returns the Credit object from the ArrayList by index.
java.util.ArrayList	getCreditsList() This method returns the list of Credit object as ArrayList object for a specified payment instruction.
int	getListSize() This method returns the size of the list, which means the number of Credit objects for the specified payment instruction.
java.lang.String	getPIId() This method returns the identifier of current payment instruction.
TypedProperty	getRequestProperties() This method returns the parameters as TypedProperty passed as part of the URL.
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	setCreditsList(java.util.ArrayList paramCreditsList) This method sets the list of Credit object as ArrayList object for a specified payment instruction.
void	setPIId(java.lang.String piId) This method sets the identifier of payment instruction with the specified value.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the passed parameters as part of the URL if any.

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

PPCListCreditsForPIDataBean

public PPCListCreditsForPIDataBean()

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 PPCListCreditsForPICmd.

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

getCreditsList

public java.util.ArrayList getCreditsList()

This method returns the list of Credit object as ArrayList object for a specified payment instruction.

Returns:

creditList The ArrayList of Credit object for a specified payment instruction

setCreditsList

public void setCreditsList(java.util.ArrayList paramCreditsList)

This method sets the list of Credit object as ArrayList object for a specified payment instruction.

Parameters:

paramCreditsList - The ArrayList of Credit object for a specified payment instruction

setPIId

public void setPIId(java.lang.String piId)

This method sets the identifier of payment instruction with the specified value.

Parameters:

piId - The identifier of payment instruction.

getPIId

public java.lang.String getPIId()

This method returns the identifier of current payment instruction.

Returns:

piID The identifier of current payment instruction

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

getCreditListData

public Credit getCreditListData(int index)
                         throws java.lang.ArrayIndexOutOfBoundsException

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

Parameters:

index - Position the current credit locates in

Returns:

Credit The credit 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 Credit objects for the specified payment instruction.

Returns:

The size of the list