Package org.odpi.openmetadata.commonservices.ffdc.rest

Class ArchiveRequestBody

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties
org.odpi.openmetadata.commonservices.ffdc.rest.ArchiveRequestBody
public class ArchiveRequestBody extends org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties
ArchiveRequestBody carries the parameters for marking an asset as archived (or deleted). The external source identifiers are used if the asset was created using the external source identifiers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArchiveRequestBody()
    Default constructor
    ArchiveRequestBody(ArchiveRequestBody template)
    Copy/clone constructor
    ArchiveRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    String
    getExternalSourceGUID()
    Return the unique identifier of the software server capability entity that represented the external source - null for local.
    String
    getExternalSourceName()
    Return the unique name of the software server capability entity that represented the external source.
    int
    hashCode()
    Return hash code for this object
    void
    setExternalSourceGUID(String externalSourceGUID)
    Set up the unique identifier of the software server capability entity that represented the external source - null for local.
    void
    setExternalSourceName(String externalSourceName)
    Set up the unique name of the software server capability entity that represented the external source.
    String
    toString()
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties

    getArchiveDate, getArchiveProcess, getArchiveProperties, setArchiveDate, setArchiveProcess, setArchiveProperties

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ArchiveRequestBody

      public ArchiveRequestBody()
      Default constructor

    • ArchiveRequestBody

      public ArchiveRequestBody(ArchiveRequestBody template)
      Copy/clone constructor
      Parameters:
      template - object to copy

    • ArchiveRequestBody

      public ArchiveRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getExternalSourceGUID

      public String getExternalSourceGUID()
      Return the unique identifier of the software server capability entity that represented the external source - null for local.
      Returns:
      string guid

    • setExternalSourceGUID

      public void setExternalSourceGUID(String externalSourceGUID)
      Set up the unique identifier of the software server capability entity that represented the external source - null for local.
      Parameters:
      externalSourceGUID - string guid

    • getExternalSourceName

      public String getExternalSourceName()
      Return the unique name of the software server capability entity that represented the external source.
      Returns:
      string name

    • setExternalSourceName

      public void setExternalSourceName(String externalSourceName)
      Set up the unique name of the software server capability entity that represented the external source.
      Parameters:
      externalSourceName - string name

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.ArchiveProperties
      Returns:
      int hash code