Package org.odpi.openmetadata.frameworks.openmetadata.properties.governance

Class RetentionProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.ClassificationProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ClassificationBeanProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceClassificationBase
org.odpi.openmetadata.frameworks.openmetadata.properties.governance.RetentionProperties
public class RetentionProperties extends GovernanceClassificationBase
RetentionClassificationProperties defines the retention requirements for related data items.

  • Constructor Details

    • RetentionProperties

      public RetentionProperties()
      Default constructor

    • RetentionProperties

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

  • Method Details

    • getBasisIdentifier

      public int getBasisIdentifier()
      Return a description of the factor used to set the archiveAfter and deleteAfter dates.
      Returns:
      int

    • setBasisIdentifier

      public void setBasisIdentifier(int basisIdentifier)
      Set up a description of the factor used to set the archiveAfter and deleteAfter dates.
      Parameters:
      basisIdentifier - int

    • getAssociatedGUID

      public String getAssociatedGUID()
      Return the unique identifier of the element used in deciding the archiveAfter and deleteAfter dates. For example if the retention basis is determined by the project lifetime, this identifier is the identifier of the associated project.
      Returns:
      string guid

    • setAssociatedGUID

      public void setAssociatedGUID(String associatedGUID)
      Set up the unique identifier of the element used in deciding the archiveAfter and deleteAfter dates. For example if the retention basis is determined by the project lifetime, this identifier is the identifier of the associated project.
      Parameters:
      associatedGUID - string guid

    • getArchiveAfter

      public Date getArchiveAfter()
      Return the date that this asset will be archived.
      Returns:
      date/timestamp

    • setArchiveAfter

      public void setArchiveAfter(Date archiveAfter)
      Set up the date that this asset will be archived.
      Parameters:
      archiveAfter - date/timestamp

    • getDeleteAfter

      public Date getDeleteAfter()
      Return the date that this asset will be permanently deleted.
      Returns:
      date/timestamp

    • setDeleteAfter

      public void setDeleteAfter(Date deleteAfter)
      Set up the date that this asset will be permanently deleted.
      Parameters:
      deleteAfter - date/timestamp

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class GovernanceClassificationBase
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class GovernanceClassificationBase
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return code value representing the contents of this object.
      Overrides:
      hashCode in class GovernanceClassificationBase
      Returns:
      int