Package com.highdeal.admin.hci

Class PurgeFileMetadataOp

java.lang.Object
com.highdeal.hci.MessageOperationAdapter
com.highdeal.admin.hci.PurgeFileMetadataOp
All Implemented Interfaces:
IXMLMarshallable, MessageOperation, XMLMarshallable
public class PurgeFileMetadataOp extends MessageOperationAdapter
FOR INTERNAL USE ONLY - See the Admin+ user interface. This operation allows to delete sets of file metadata linked to a root data file whose purge reference date is lower than the specified reference date.

Operation Result

PurgeFileMetadataResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeNoNoNoNoNoYes

Audit Domain

This operation is audited by the system as part of the audit domain: ADMINISTRATION. Consult the IT administrator.

  • Field Details

  • Constructor Details

    • PurgeFileMetadataOp

      public PurgeFileMetadataOp()

  • 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

    • getName

      public String getName()
      Description copied from interface: MessageOperation
      Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

      Example

      • activateAll
      • ping
      Returns:
      The technical name of the HCI operation

    • 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