atg.commerce.invoice.pipeline

Class InvoicePipelineArgs

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

atg.commerce.invoice.pipeline.InvoicePipelineArgs

All Implemented Interfaces:

InvoicePipelineConstants, java.io.Serializable, java.lang.Cloneable, java.util.Map

Direct Known Subclasses:

InvoicePipelineArgs

public class InvoicePipelineArgs
extends java.util.HashMap
implements InvoicePipelineConstants

InvoicePipelineArgs provides a dictionary for storing arguments to the invoice pipeline and includes convenience methods for looking up well-known names within that dictionary.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Fields inherited from interface atg.commerce.invoice.pipeline.InvoicePipelineConstants

INVOICE_ITEM, INVOICE_MANAGER, INVOICE_REQUEST_INFO

Constructor Summary

Constructors

Constructor and Description
InvoicePipelineArgs() Create a new empty instance of InvoicePipelineArgs.
InvoicePipelineArgs(InvoiceManager pManager, RepositoryItem pItem) Create a new instance of InvoicePipelineArgs, storing the specified invoice manager and repository item under well-known keys in the dictionary.
InvoicePipelineArgs(InvoiceManager pManager, RepositoryItem pItem, InvoiceRequestInfo pInfo) Create a new instance of InvoicePipelineArgs, storing the specified invoice manager, repository item, and invoice request info used for initialization under well-known keys in the dictionary.

Method Summary

Methods

Modifier and Type	Method and Description
RepositoryItem	getInvoice() Retrieve the invoice object being operated on, using its well-known name as the lookup key in the dictionary.
InvoiceManager	getInvoiceManager() Retrieve the invoice manager from this object, using its well-known name as the lookup key in the dictionary.
InvoiceRequestInfo	getInvoiceRequestInfo() Retrieve the InvoiceRequestInfo from which this invoice object is to be initialized, if the current pipeline chain is the initialize invoice chain.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

InvoicePipelineArgs

public InvoicePipelineArgs()

Create a new empty instance of InvoicePipelineArgs.

InvoicePipelineArgs

public InvoicePipelineArgs(InvoiceManager pManager,
                   RepositoryItem pItem)

Create a new instance of InvoicePipelineArgs, storing the specified invoice manager and repository item under well-known keys in the dictionary.

InvoicePipelineArgs

public InvoicePipelineArgs(InvoiceManager pManager,
                   RepositoryItem pItem,
                   InvoiceRequestInfo pInfo)

Create a new instance of InvoicePipelineArgs, storing the specified invoice manager, repository item, and invoice request info used for initialization under well-known keys in the dictionary.

Method Detail

getInvoiceManager

public InvoiceManager getInvoiceManager()

Retrieve the invoice manager from this object, using its well-known name as the lookup key in the dictionary.

getInvoice

public RepositoryItem getInvoice()

Retrieve the invoice object being operated on, using its well-known name as the lookup key in the dictionary.

getInvoiceRequestInfo

public InvoiceRequestInfo getInvoiceRequestInfo()

Retrieve the InvoiceRequestInfo from which this invoice object is to be initialized, if the current pipeline chain is the initialize invoice chain. Otherwise this method returns null.