Package org.odpi.openmetadata.accessservices.itinfrastructure.properties

Class ContactMethodProperties

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.properties.ContactMethodProperties
public class ContactMethodProperties extends Object
ContactMethodProperties describes a single mechanism that can be used to contact an individual.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContactMethodProperties()
    Default constructor
    ContactMethodProperties(ContactMethodProperties template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    String
    getContactMethodService()
    Return the URL of the service used to contact the individual.
    org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType
    getContactMethodType()
    Return the type of the contact method.
    String
    getContactMethodValue()
    Return the account name or similar value used to direct the message to the individual.
    String
    getContactType()
    Return the type of contact - is it related to work or personal etc.
    Date
    getEffectiveFrom()
    Return the date/time that this element is effective from (null means effective from the epoch).
    Date
    getEffectiveTo()
    Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
    Map<String,Object>
    getExtendedProperties()
    Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
    String
    getName()
    Return the name to give this contact method (imagine a list of contact methods).
    String
    getTypeName()
    Return the name of the open metadata type for this metadata element.
    int
    hashCode()
    Hash code for this object
    void
    setContactMethodService(String contactMethodService)
    Set up theURL of the service used to contact the individual.
    void
    setContactMethodType(org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType contactMethodType)
    Set up the type of the contact method.
    void
    setContactMethodValue(String contactMethodValue)
    Set up the account name or similar value used to direct the message to the individual.
    void
    setContactType(String contactType)
    Set up the type of contact - is it related to work or personal etc.
    void
    setEffectiveFrom(Date effectiveFrom)
    Set up the date/time that this element is effective from (null means effective from the epoch).
    void
    setEffectiveTo(Date effectiveTo)
    Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
    void
    setExtendedProperties(Map<String,Object> extendedProperties)
    Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
    void
    setName(String name)
    Set up the name to give this contact method (imagine a list of contact methods).
    void
    setTypeName(String typeName)
    Set up the name of the open metadata type for this element.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ContactMethodProperties

      public ContactMethodProperties()
      Default constructor

    • ContactMethodProperties

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

  • Method Details

    • getName

      public String getName()
      Return the name to give this contact method (imagine a list of contact methods).
      Returns:
      string

    • setName

      public void setName(String name)
      Set up the name to give this contact method (imagine a list of contact methods).
      Parameters:
      name - string

    • getContactType

      public String getContactType()
      Return the type of contact - is it related to work or personal etc.
      Returns:
      string type name - often controlled by a valid value set

    • setContactType

      public void setContactType(String contactType)
      Set up the type of contact - is it related to work or personal etc.
      Parameters:
      contactType - string type name - often controlled by a valid value set

    • getContactMethodType

      public org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType getContactMethodType()
      Return the type of the contact method.
      Returns:
      contact method type enum

    • setContactMethodType

      public void setContactMethodType(org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType contactMethodType)
      Set up the type of the contact method.
      Parameters:
      contactMethodType - contact method type enum

    • getContactMethodService

      public String getContactMethodService()
      Return the URL of the service used to contact the individual.
      Returns:
      service URL

    • setContactMethodService

      public void setContactMethodService(String contactMethodService)
      Set up theURL of the service used to contact the individual.
      Parameters:
      contactMethodService - service URL

    • getContactMethodValue

      public String getContactMethodValue()
      Return the account name or similar value used to direct the message to the individual.
      Returns:
      value string

    • setContactMethodValue

      public void setContactMethodValue(String contactMethodValue)
      Set up the account name or similar value used to direct the message to the individual.
      Parameters:
      contactMethodValue - value string

    • getEffectiveFrom

      public Date getEffectiveFrom()
      Return the date/time that this element is effective from (null means effective from the epoch).
      Returns:
      date object

    • setEffectiveFrom

      public void setEffectiveFrom(Date effectiveFrom)
      Set up the date/time that this element is effective from (null means effective from the epoch).
      Parameters:
      effectiveFrom - date object

    • getEffectiveTo

      public Date getEffectiveTo()
      Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
      Returns:
      date object

    • setEffectiveTo

      public void setEffectiveTo(Date effectiveTo)
      Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
      Parameters:
      effectiveTo - date object

    • getTypeName

      public String getTypeName()
      Return the name of the open metadata type for this metadata element.
      Returns:
      string name

    • setTypeName

      public void setTypeName(String typeName)
      Set up the name of the open metadata type for this element.
      Parameters:
      typeName - string name

    • getExtendedProperties

      public Map<String,Object> getExtendedProperties()
      Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
      Returns:
      property map

    • setExtendedProperties

      public void setExtendedProperties(Map<String,Object> extendedProperties)
      Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
      Parameters:
      extendedProperties - property map

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class Object
      Returns:
      list of properties and their values.

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int