Package org.odpi.openmetadata.frameworks.openmetadata.properties.contextevents

Class ContextEventProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.SupplementaryProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.contextevents.ContextEventProperties
public class ContextEventProperties extends SupplementaryProperties
ContextEventProperties holds properties that are used for displaying details of context event.

  • Constructor Details

    • ContextEventProperties

      public ContextEventProperties()
      Default constructor

    • ContextEventProperties

      public ContextEventProperties(ContextEventProperties template)
      Copy/clone constructor. Note, this is a deep copy
      Parameters:
      template - object to copy

  • Method Details

    • getName

      public String getName()
      Return the short name of the event that is used when displaying the event in tables etc.
      Returns:
      string

    • setName

      public void setName(String name)
      Set up the short name of the event that is used in tables etc.
      Parameters:
      name - string event name

    • getContextEventType

      public String getContextEventType()
      Return the type of the event.
      Returns:
      string

    • setContextEventType

      public void setContextEventType(String contextEventType)
      Set up the type of the event .
      Parameters:
      contextEventType - string

    • getDisplayName

      public String getDisplayName()
      Return the business oriented display name.
      Overrides:
      getDisplayName in class SupplementaryProperties
      Returns:
      display name

    • getEventEffect

      public String getEventEffect()
      Set up the effect of the event.
      Returns:
      string version name

    • setEventEffect

      public void setEventEffect(String eventEffect)
      Set up the effect of the event.
      Parameters:
      eventEffect - string version name

    • getEventDescription

      public String getEventDescription()
      Returns the stored description property extracted from the event. If no description is provided then null is returned.
      Returns:
      description String text

    • setEventDescription

      public void setEventDescription(String eventDescription)
      Set up the stored description property extracted from the event.
      Parameters:
      eventDescription - String text

    • getDisplayDescription

      public String getDisplayDescription()
      This override defaults the display description to the event description if it is null;
      Overrides:
      getDisplayDescription in class SupplementaryProperties
      Returns:
      description

    • getPlannedStartDate

      public Date getPlannedStartDate()
      Return the planned start date for the event.
      Returns:
      date

    • setPlannedStartDate

      public void setPlannedStartDate(Date plannedStartDate)
      Set up the planned start date for the event.
      Parameters:
      plannedStartDate - date

    • getActualStartDate

      public Date getActualStartDate()
      Return the actual start date for the event.
      Returns:
      date

    • setActualStartDate

      public void setActualStartDate(Date actualStartDate)
      Set up the actual start date for the event.
      Parameters:
      actualStartDate - date

    • getPlannedDuration

      public long getPlannedDuration()
      Return the number of milliseconds that the event is due to run for.
      Returns:
      long

    • setPlannedDuration

      public void setPlannedDuration(long plannedDuration)
      Set up the number of milliseconds that the event is due to run for.
      Parameters:
      plannedDuration - long

    • getActualDuration

      public long getActualDuration()
      Return the actual duration of the event in milliseconds.
      Returns:
      long

    • setActualDuration

      public void setActualDuration(long actualDuration)
      Set up the actual duration of the event in milliseconds.
      Parameters:
      actualDuration - long

    • getRepeatInterval

      public long getRepeatInterval()
      Return the number of milliseconds between repeated occurrences of the event.
      Returns:
      long

    • setRepeatInterval

      public void setRepeatInterval(long repeatInterval)
      Set up the number of milliseconds between repeated occurrences of the event.
      Parameters:
      repeatInterval - long

    • getPlannedCompletionDate

      public Date getPlannedCompletionDate()
      Return the expected completion date for this event.
      Returns:
      date

    • setPlannedCompletionDate

      public void setPlannedCompletionDate(Date plannedCompletionDate)
      Set up the expected completion date for this event.
      Parameters:
      plannedCompletionDate - date

    • getActualCompletionDate

      public Date getActualCompletionDate()
      Return the actual date that the event ended.
      Returns:
      date

    • setActualCompletionDate

      public void setActualCompletionDate(Date actualCompletionDate)
      Set up the actual date that the event ended.
      Parameters:
      actualCompletionDate - date

    • getReferenceEffectiveFrom

      public Date getReferenceEffectiveFrom()
      Return the date to use as an effective from value in elements tied to the context event.
      Returns:
      date

    • setReferenceEffectiveFrom

      public void setReferenceEffectiveFrom(Date referenceEffectiveFrom)
      set up the date to use as an effective from value in elements tied to the context event.
      Parameters:
      referenceEffectiveFrom - date

    • getReferenceEffectiveTo

      public Date getReferenceEffectiveTo()
      Return the date to use as an effective to value in elements tied to the context event.
      Returns:
      date

    • setReferenceEffectiveTo

      public void setReferenceEffectiveTo(Date referenceEffectiveTo)
      Set up the date to use as an effective to value in elements tied to the context event.
      Parameters:
      referenceEffectiveTo - date

    • toString

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

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class SupplementaryProperties
      Returns:
      int