Class ContactMethodProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class ContactMethodProperties
    extends java.lang.Object
    implements java.io.Serializable
    ContactMethodProperties describes a single mechanism that can be used to contact an individual.
    See Also:
    Serialized Form
    • Method Summary

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

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ContactMethodProperties

        public ContactMethodProperties()
        Default constructor
      • ContactMethodProperties

        public ContactMethodProperties​(ContactMethodProperties template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getName

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

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

        public java.lang.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​(java.lang.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 ContactMethodType getContactMethodType()
        Return the type of the contact method.
        Returns:
        contact method type enum
      • setContactMethodType

        public void setContactMethodType​(ContactMethodType contactMethodType)
        Set up the type of the contact method.
        Parameters:
        contactMethodType - contact method type enum
      • getContactMethodService

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

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

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

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

        public java.util.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​(java.util.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 java.util.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​(java.util.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 java.lang.String getTypeName()
        Return the name of the open metadata type for this metadata element.
        Returns:
        string name
      • setTypeName

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

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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 java.lang.String toString()
        JSON-style toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        list of properties and their values.
      • equals

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

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