com.highdeal.admin.hci
Class GetFilesToBulkLoadResult

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.hci.OperationResultAdapter
          com.highdeal.admin.hci.GetFilesToBulkLoadResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable

public class GetFilesToBulkLoadResult
extends OperationResultAdapter

This operation result is returned when a bulk loading operation has successfully ended.

Operation Request

GetFilesToBulkLoadOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getFilesToBulkLoadResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="fileToBulkLoad" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String

OPERATION_NAME The name of the operation

Constructor Summary

GetFilesToBulkLoadResult()
Builds an empty GetFilesToBulkLoadResult.

Method Summary

void	addCharacterData(java.lang.String data) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.util.List<FileToBulkLoad>	getFilesToBulkLoad() Gets the list of files to bulk load.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
java.lang.String	getTagName() Gets the XML tag name of the HCI operation result.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setFileToBulkLoadList(java.util.List<FileToBulkLoad> list) Sets the list of files to bulk load

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highdeal.hci.XMLMarshallable

marshal

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The name of the operation

See Also:

Constant Field Values

Constructor Detail

GetFilesToBulkLoadResult

public GetFilesToBulkLoadResult()

Builds an empty GetFilesToBulkLoadResult.

Method Detail

setFileToBulkLoadList

public void setFileToBulkLoadList(java.util.List<FileToBulkLoad> list)

Sets the list of files to bulk load

Parameters:

list - the list of files to bulk load

getFilesToBulkLoad

public java.util.List<FileToBulkLoad> getFilesToBulkLoad()

Gets the list of files to bulk load.

Returns:

the list of files to bulk load

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Returns:

The operand reference of the operation result

addCharacterData

public void addCharacterData(java.lang.String data)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

data - The character data to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into

getTagName

public java.lang.String getTagName()

Description copied from class: OperationResultAdapter

Gets the XML tag name of the HCI operation result.

Specified by:

getTagName in interface ITagNameProvider

Specified by:

getTagName in class OperationResultAdapter

Returns:

The XML tag name