Package com.highdeal.admin.hci

Class PurgeFileMetadataResult

java.lang.Object
com.highdeal.hci.HCIModelAdapter
com.highdeal.hci.OperationResultAdapter
com.highdeal.admin.hci.PurgeFileMetadataResult
All Implemented Interfaces:
ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable
public class PurgeFileMetadataResult extends OperationResultAdapter
FOR INTERNAL USE ONLY - See the Admin+ user interface. This class represents the result of the Purge File Metadata operation. It contains the number of file metadata deleted during the execution of the operation.

Operation Request

PurgeFileMetadataOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="purgeFileMetadataResult">
   <xs:complexType>
     <xs:attribute name="referenceDate" type="xs:dateTime" use="required" />
     <xs:attribute name="purgedCount" type="xs:integer" use="required" />
   </xs:complexType>
 </xs:element>

  • Field Details

  • Constructor Details

    • PurgeFileMetadataResult

      public PurgeFileMetadataResult()

  • Method Details

    • getReferenceDate

      public Date getReferenceDate()
      Gets the reference date for the purge operation.
      Returns:
      the reference date for the purge operation

    • setReferenceDate

      public void setReferenceDate(Date referenceDate)
      Sets the reference date for the purge operation.
      Parameters:
      referenceDate - the reference date for the purge operation

    • getPurgedCount

      public int getPurgedCount()
      Gets the number of file metadata deleted during the purge operation.
      Returns:
      the number of file metadata deleted during the purge operation

    • setPurgedCount

      public void setPurgedCount(int purgedCount)
      Sets the number of file metadata deleted during the purge operation.
      Parameters:
      purgedCount - the number of file metadata deleted during the purge operation

    • getOperandReference

      public 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

    • getTagName

      public 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

    • 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

    • 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

    • addChild

      public void addChild(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

    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Parameters:
      cData - The character data to be added