Package org.odpi.openmetadata.accessservices.securitymanager.properties

Class ContactMethodProperties

  • All Implemented Interfaces:
    Serializable
    public class ContactMethodProperties
extends Object
implements Serializable
    ContactMethodProperties describes a single mechanism that can be used to contact an individual.
    See Also:
    Serialized Form

    • Constructor Detail

      • ContactMethodProperties

        public ContactMethodProperties()
        Default constructor

      • ContactMethodProperties

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

    • Method Detail

      • 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 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 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