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.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 getService()
      Return the URL of the service used to contact the individual.
      ContactMethodType getType()
      Return the type of the contact method.
      java.lang.String getTypeName()
      Return the name of the open metadata type for this metadata element.
      java.lang.String getValue()
      Return the account name or similar value used to direct the message to the individual.
      int hashCode()
      Hash code for this object
      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 setService​(java.lang.String service)
      Set up theURL of the service used to contact the individual.
      void setType​(ContactMethodType type)
      Set up the type of the contact method.
      void setTypeName​(java.lang.String typeName)
      Set up the name of the open metadata type for this element.
      void setValue​(java.lang.String value)
      Set up the account name or similar value used to direct the message to the individual.
      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

      • getType

        public ContactMethodType getType()
        Return the type of the contact method.
        Returns:
        contact method type enum
      • setType

        public void setType​(ContactMethodType type)
        Set up the type of the contact method.
        Parameters:
        type - contact method type enum
      • getService

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

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

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

        public void setValue​(java.lang.String value)
        Set up the account name or similar value used to direct the message to the individual.
        Parameters:
        value - 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