com.highdeal.admin.hci

Class FileToBulkLoad

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.admin.hci.FileToBulkLoad

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class FileToBulkLoad
extends HCIModelAdapter

This Java class represents a file that was fetched by a rater instance and that is ready to be bulk loaded to another system.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="fileToBulkLoad">
  <xs:complexType>
    <xs:attribute name="fileName" type="xs:string" use="required"/>
    <xs:attribute name="creationDate" type="xs:dateTime" use="required"/>
    <xs:attribute name="instanceType" type="FromInstanceType" use="required"/>
    <xs:attribute name="inError" type="xs:boolean" use="required"/>
  </xs:complexType>
 </xs:element>

 <xs:simpleType name="FromInstanceType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="rater"/>
      <xs:enumeration value="bulkLoader"/>
   </xs:restriction>
 </xs:simpleType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileToBulkLoad.FromInstanceType This enumeration lists all the instance types from which the file is created (rater, bulkloader).

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDITIONAL_INFO Additional Info
static String	CREATION_DATE Mapping for the creation date: "creationDate"
static String	FILE_NAME Mapping for the file name: "fileName"
static String	INSTANCE_TYPE Mapping for the instance type: "instanceType"
static String	IS_IN_ERROR Mapping for the is in error flag: "isInError"
static String	TAG_NAME Mapping for the status model: "fileToBulkLoad"

Constructor Summary

Constructors

Constructor and Description
FileToBulkLoad() Builds an empty FileToBulkLoad.
FileToBulkLoad(String fileName, Date creationDate, FileToBulkLoad.FromInstanceType instanceType, boolean isInError, String additionalInfo) Initializes a new FileToBulkLoadModel instance with the file information.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds string data to this model.
void	addChild(String tagName, XMLMarshallable child) Adds a child tag to this model.
String	getAdditionalInfo() Gets the additional information.
Date	getCreationDate() Gets the date of file creation.
String	getFileName() Gets the file name.
FileToBulkLoad.FromInstanceType	getFromInstanceType() Gets the instance type from which the file was created.
String	getTagName() Gets the XML tag name of the HCI model.
boolean	isInError() Returns if the file is in error.
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	setAdditionalInfo(String additionalInfo) Sets the additional information.
void	setAttributes(XMLAttributes atts) Sets the operation attributes from the XMLAttributes.
void	setInError(boolean inError) Sets if the file is in error or not.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

Mapping for the status model: "fileToBulkLoad"

See Also:

Constant Field Values

FILE_NAME

public static final String FILE_NAME

Mapping for the file name: "fileName"

See Also:

Constant Field Values

CREATION_DATE

public static final String CREATION_DATE

Mapping for the creation date: "creationDate"

See Also:

Constant Field Values

INSTANCE_TYPE

public static final String INSTANCE_TYPE

Mapping for the instance type: "instanceType"

See Also:

Constant Field Values

IS_IN_ERROR

public static final String IS_IN_ERROR

Mapping for the is in error flag: "isInError"

See Also:

Constant Field Values

ADDITIONAL_INFO

public static final String ADDITIONAL_INFO

Additional Info

See Also:

Constant Field Values

Constructor Detail

FileToBulkLoad

public FileToBulkLoad()

Builds an empty FileToBulkLoad.

FileToBulkLoad

public FileToBulkLoad(String fileName,
                      Date creationDate,
                      FileToBulkLoad.FromInstanceType instanceType,
                      boolean isInError,
                      String additionalInfo)

Initializes a new FileToBulkLoadModel instance with the file information.

Parameters:

fileName - The name of the file

creationDate - The date when the file was created

instanceType - The type of the instance which created the file

isInError - A flag indicating if the file is in error or not

additionalInfo - The additional information

Method Detail

getFileName

public String getFileName()

Gets the file name.

Returns:

The file name

getCreationDate

public Date getCreationDate()

Gets the date of file creation.

Returns:

The date of file creation

getFromInstanceType

public FileToBulkLoad.FromInstanceType getFromInstanceType()

Gets the instance type from which the file was created.

Returns:

The instance type from which the file was created

setInError

public void setInError(boolean inError)

Sets if the file is in error or not.

Parameters:

inError - true if the file is in error, false otherwise

isInError

public boolean isInError()

Returns if the file is in error.

Returns:

true if the file is in error, false otherwise

getAdditionalInfo

public String getAdditionalInfo()

Gets the additional information.

Returns:

The additional information

setAdditionalInfo

public void setAdditionalInfo(String additionalInfo)

Sets the additional information.

Parameters:

additionalInfo - The additional information

setAttributes

public void setAttributes(XMLAttributes atts)

Sets the operation attributes from the XMLAttributes.

Parameters:

atts - The XMLAttributes containing the data

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Adds a child tag to this model.

This tag is ignored for this model.

Parameters:

tagName - The name of the tag

child - The XMLMarshallable child to add

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 String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name

addCharacterData

public void addCharacterData(String cData)

Adds string data to this model.

This data is ignored for this model.

Parameters:

cData - The character data to add to the operation