complexType {http://java.sun.com/products/oss/xml/IPBilling}TransferStatusValue
Source
<complexType name="TransferStatusValue">
<annotation>
<documentation>
This interface represents the attributes of all types of
Data Transfer Status Entities in IP Billing API.
<p>
This is a base Value Object interface to the <CODE>TransferStatusValue</CODE> Entity.
This interface and its sub interfaces (if any) provide several ways
to access the attributes:
<p>
<UL>
<LI>Attributes can be accessed through standard JavaBeans get/set (isSet)
methods.
<LI>Attributes can be accessed through the generic methods defined
in <CODE>AttributeAccess</CODE>
<UL>
<LI><CODE>Object getAttributeValue(String attributeName)</CODE>
<LI><CODE>void setAttributeValue(String attributeName, Object newValue)</CODE>
</UL>
</UL>
<p>
A <CODE>TransferStatusValue</CODE> entity is used to persistently represent information
regarding the transfer of Usage Records from a <CODE>Producer</CODE> to a client.
This base interface only provides the ability to store
retrieve the status of the data transfer and the Usage Record Subscription
value object associated with this transfer. More specific interfaces can
be developed by means of derivation to provide more useful behavior
for a specific type of transfer. For example, if a <CODE>Producer</CODE> Entity
capable of re-transmissions, a specialized <CODE>TransferStatusValue</CODE> Entity can
save the information about failed Usage Record transfers, so that, they
may be retried or re-conciled at a later time.
<p>
An entity of <CODE>TransferStatusValue</CODE> is created by the
<CODE>Producer</CODE>, whenever a transfer
record needs to be kept.
The reporting parameters are preserved in the optional
<CODE>reportingParams</CODE> attribute for understanding the reporting
schemes involved.
<p>
The <CODE>TransferStatusValue</CODE> entity is not removed by the <CODE>Producer</CODE> entity after
the Data Transfer is complete. Instead, it is left to persistently
log the Data Transfer information, for auditing purposes. In order to
avoid creation of large number of Data Transfer Status Entities in the
<CODE>Producer</CODE>'s storage, there must be an aging policy for retiring the
unused Usage Data Transfer Status entities. Currently this is left
unspecified by this API.
</documentation>
</annotation>
<complexContent>
<extension base="co:ManagedEntityValue">
<sequence>
<element name="transferStatusKey" minOccurs="0" nillable="true"
type="ipb:TransferStatusKey"/>
<element name="transferStatusCode" minOccurs="0" nillable="true" type="int"/>
<element name="transferFailureReason" minOccurs="0" nillable="true" type="string"/>
<element name="reportingParams" minOccurs="0" nillable="true"
type="cfi:ActivityReportParams"/>
</sequence>
</extension>
</complexContent>
</complexType>
Documentation
This interface represents the attributes of all types of
Data Transfer Status Entities in IP Billing API.
<p>
This is a base Value Object interface to the <CODE>TransferStatusValue</CODE> Entity.
This interface and its sub interfaces (if any) provide several ways
to access the attributes:
<p>
<UL>
<LI>Attributes can be accessed through standard JavaBeans get/set (isSet)
methods.
<LI>Attributes can be accessed through the generic methods defined
in <CODE>AttributeAccess</CODE>
<UL>
<LI><CODE>Object getAttributeValue(String attributeName)</CODE>
<LI><CODE>void setAttributeValue(String attributeName, Object newValue)</CODE>
</UL>
</UL>
<p>
A <CODE>TransferStatusValue</CODE> entity is used to persistently represent information
regarding the transfer of Usage Records from a <CODE>Producer</CODE> to a client.
This base interface only provides the ability to store
retrieve the status of the data transfer and the Usage Record Subscription
value object associated with this transfer. More specific interfaces can
be developed by means of derivation to provide more useful behavior
for a specific type of transfer. For example, if a <CODE>Producer</CODE> Entity
capable of re-transmissions, a specialized <CODE>TransferStatusValue</CODE> Entity can
save the information about failed Usage Record transfers, so that, they
may be retried or re-conciled at a later time.
<p>
An entity of <CODE>TransferStatusValue</CODE> is created by the
<CODE>Producer</CODE>, whenever a transfer
record needs to be kept.
The reporting parameters are preserved in the optional
<CODE>reportingParams</CODE> attribute for understanding the reporting
schemes involved.
<p>
The <CODE>TransferStatusValue</CODE> entity is not removed by the <CODE>Producer</CODE> entity after
the Data Transfer is complete. Instead, it is left to persistently
log the Data Transfer information, for auditing purposes. In order to
avoid creation of large number of Data Transfer Status Entities in the
<CODE>Producer</CODE>'s storage, there must be an aging policy for retiring the
unused Usage Data Transfer Status entities. Currently this is left
unspecified by this API.
Stylus Studio®, a product from DataDirect Technologies,
is a registered trademark of
Progress Software Corporation,
in the U.S. and other countries. © 2004-2006
All Rights Reserved.
{http://java.sun.com/products/oss/xml/IPBilling}TransferStatusValue
