java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.properties.PersonalRoleProperties
Direct Known Subclasses:
PersonRoleProperties

public class PersonalRoleProperties extends Object
PersonalRoleProperties provides a structure for describe a role assigned to a person.
  • Constructor Details

    • PersonalRoleProperties

      public PersonalRoleProperties()
      Default constructor
    • PersonalRoleProperties

      public PersonalRoleProperties(PersonalRoleProperties template)
      Copy/clone constructor
      Parameters:
      template - object to copy
  • Method Details

    • getQualifiedName

      public String getQualifiedName()
      Return the unique name for element in open metadata ecosystem.
      Returns:
      unique name
    • setQualifiedName

      public void setQualifiedName(String qualifiedName)
      Set up the unique name for element in open metadata ecosystem.
      Parameters:
      qualifiedName - unique name
    • getRoleId

      public String getRoleId()
      Return the unique identifier for this job role/appointment typically from an HR system.
      Returns:
      unique identifier
    • setRoleId

      public void setRoleId(String roleId)
      Set up the unique identifier for this job role/appointment.
      Parameters:
      roleId - unique identifier
    • getScope

      public String getScope()
      Return the context in which the person is appointed. This may be an organizational scope, location, or scope of assets.
      Returns:
      string description
    • setScope

      public void setScope(String scope)
      Set up the context in which the person is appointed. This may be an organizational scope, location, or scope of assets.
      Parameters:
      scope - string description
    • getTitle

      public String getTitle()
      Return the job role title.
      Returns:
      string name
    • setTitle

      public void setTitle(String title)
      Set up the job role title.
      Parameters:
      title - string name
    • getDescription

      public String getDescription()
      Return the description of the job role.
      Returns:
      string description
    • setDescription

      public void setDescription(String description)
      Set up the description of the job role.
      Parameters:
      description - string description
    • getDomainIdentifier

      public int getDomainIdentifier()
      Return the identifier of the governance domain that this role belongs to. Zero means that the role is not specific to any domain.
      Returns:
      int
    • setDomainIdentifier

      public void setDomainIdentifier(int domainIdentifier)
      Set up the identifier of the governance domain that this role belongs to. Zero means that the role is not specific to any domain.
      Parameters:
      domainIdentifier - int
    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return a copy of the additional properties. Null means no additional properties are available.
      Returns:
      AdditionalProperties map
    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up additional properties.
      Parameters:
      additionalProperties - Additional properties map
    • 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 open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.
      Returns:
      string type name
    • setTypeName

      public void setTypeName(String typeName)
      Set up the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.
      Parameters:
      typeName - string type name
    • getExtendedProperties

      public Map<String,Object> getExtendedProperties()
      Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
      Returns:
      map of properties
    • setExtendedProperties

      public void setExtendedProperties(Map<String,Object> extendedProperties)
      Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
      Parameters:
      extendedProperties - map of properties
    • 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()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code