Package 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>

  • Field Details

  • Constructor Details

    • 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 Details

    • 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