Package org.odpi.openmetadata.frameworks.surveyaction.properties

Class SurveyReport

java.lang.Object
org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase
org.odpi.openmetadata.frameworks.surveyaction.properties.SurveyReport
All Implemented Interfaces:
Serializable
public class SurveyReport extends PropertyBase
SurveyReport describes the properties for a survey report.
See Also:

  • Constructor Details

    • SurveyReport

      public SurveyReport()
      Default constructor

    • SurveyReport

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

  • Method Details

    • setQualifiedName

      public void setQualifiedName(String qualifiedName)
      Set up the fully qualified name.
      Parameters:
      qualifiedName - String name

    • getQualifiedName

      public String getQualifiedName()
      Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.
      Returns:
      qualifiedName

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up additional properties.
      Parameters:
      additionalProperties - Additional properties object

    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return a copy of the additional properties. Null means no additional properties are available.
      Returns:
      AdditionalProperties

    • getDisplayName

      public String getDisplayName()
      Return the display name of the survey report.
      Returns:
      String report name

    • setDisplayName

      public void setDisplayName(String reportName)
      Set up the display name of the survey report.
      Parameters:
      reportName - String report name

    • getDescription

      public String getDescription()
      Return the survey report description.
      Returns:
      String report description

    • setDescription

      public void setDescription(String reportDescription)
      Set up the survey report description.
      Parameters:
      reportDescription - String report description

    • getPurpose

      public String getPurpose()
      Return the purpose of the survey.
      Returns:
      Date that the report was created.

    • setPurpose

      public void setPurpose(String purpose)
      Set up the creation date for the report. If this date is not known then null is returned.
      Parameters:
      purpose - Date that the report was created.

    • getUser

      public String getUser()
      Return the user that ran the survey action service.
      Returns:
      user

    • setUser

      public void setUser(String user)
      Set up the user that ran the survey action service.
      Parameters:
      user - userId

    • getStartDate

      public Date getStartDate()
      Return the creation date for the report. If this date is not known then null is returned.
      Returns:
      Date that the report was created.

    • setStartDate

      public void setStartDate(Date date)
      Set up the creation date for the report. If this date is not known then null is returned.
      Parameters:
      date - Date that the report was created.

    • getCompletionDate

      public Date getCompletionDate()
      Return the completion date for the report. If this date is not known then null is returned.
      Returns:
      Date that the report was completed.

    • setCompletionDate

      public void setCompletionDate(Date date)
      Set up the completion date for the report. If this date is not known then null is returned.
      Parameters:
      date - Date that the report was completed.

    • getAnalysisParameters

      public Map<String,String> getAnalysisParameters()
      Return the parameters used to drive the discovery service's analysis.
      Returns:
      map storing the analysis parameters

    • setAnalysisParameters

      public void setAnalysisParameters(Map<String,String> analysisParameters)
      Set up the parameters used to drive the discovery service's analysis.
      Parameters:
      analysisParameters - map storing the analysis parameters

    • getAssetGUID

      public String getAssetGUID()
      Return the unique identifier of the asset that was analyzed.
      Returns:
      unique identifier (guid)

    • setAssetGUID

      public void setAssetGUID(String assetGUID)
      Set up the unique identifier of the asset that was analyzed.
      Parameters:
      assetGUID - unique identifier (guid)

    • getCompletionMessage

      public String getCompletionMessage()
      Return the completion message - it may be null which means it completed ok.
      Returns:
      string text

    • setCompletionMessage

      public void setCompletionMessage(String message)
      Set up the completion message - it may be null which means it completed ok.
      Parameters:
      message - text of completion message

    • getEngineActionGUID

      public String getEngineActionGUID()
      Return the unique identifier for the engine action associated with this report.
      Returns:
      guid

    • setEngineActionGUID

      public void setEngineActionGUID(String engineActionGUID)
      Set up the unique identifier for the engine action associated with this report.
      Parameters:
      engineActionGUID - guid

    • getAnalysisStep

      public String getAnalysisStep()
      Return the locally defined analysis step. This value is used in annotations generated in this phase.
      Returns:
      name of analysis step

    • setAnalysisStep

      public void setAnalysisStep(String analysisStep)
      Set up the name of the current analysis step.
      Parameters:
      analysisStep - name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      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 Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class Object
      Returns:
      int hash code