Package org.odpi.openmetadata.accessservices.governanceprogram.properties

Class PersonRoleProperties

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.properties.PersonRoleProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
GovernanceRoleProperties
public class PersonRoleProperties extends Object implements Serializable
PersonRoleProperties provides a structure for describe a role assigned to a person.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PersonRoleProperties()
    Default constructor
    PersonRoleProperties(PersonRoleProperties 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.
    Map<String,String>
    getAdditionalProperties()
    Return a copy of the additional properties.
    String
    getDescription()
    Return the description of the job role for this governance appointment.
    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 are defined for a subtype of referenceable but are not explicitly supported by the bean.
    int
    getHeadCount()
    Return the number of people that can be appointed to this role.
    boolean
    getHeadCountLimitSet()
    Return the indicator whether the head count limit is set for a person role.
    String
    getQualifiedName()
    Return the unique name for element in open metadata ecosystem.
    String
    getRoleId()
    Return the unique identifier for this job role/appointment typically from an HR system.
    String
    getScope()
    Return the context in which the governance officer is appointed.
    String
    getTitle()
    Return the job role title.
    String
    getTypeName()
    Return the open metadata type name of this object - this is used to create a subtype of the referenceable.
    int
    hashCode()
    Return hash code for this object
    void
    setAdditionalProperties(Map<String,String> additionalProperties)
    Set up additional properties.
    void
    setDescription(String description)
    Set up the description of the job role for this governance officer.
    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 are defined for a subtype of referenceable but are not explicitly supported by the bean.
    void
    setHeadCount(int headCount)
    Set up the number of people that can be appointed to this role.
    void
    setHeadCountLimitSet(boolean headCountLimitSet)
    Set up the indicator whether the head count limit is set for a person role.
    void
    setQualifiedName(String qualifiedName)
    Set up the unique name for element in open metadata ecosystem.
    void
    setRoleId(String roleId)
    Set up the unique identifier for this job role/appointment.
    void
    setScope(String scope)
    Set up the context in which the governance officer is appointed.
    void
    setTitle(String title)
    Set up the job role title.
    void
    setTypeName(String typeName)
    Set up the open metadata type name of this object - this is used to create a subtype of the referenceable.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PersonRoleProperties

      public PersonRoleProperties()
      Default constructor

    • PersonRoleProperties

      public PersonRoleProperties(PersonRoleProperties 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 governance officer 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 governance officer 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 for this governance appointment. This may relate to the specific governance responsibilities, or may be their main role if the governance responsibilities are just an adjunct to their main role.
      Returns:
      string description

    • setDescription

      public void setDescription(String description)
      Set up the description of the job role for this governance officer. This may relate to the specific governance responsibilities, or may be their main role if the governance responsibilities are just an adjunct to their main role.
      Parameters:
      description - string description

    • getHeadCountLimitSet

      public boolean getHeadCountLimitSet()
      Return the indicator whether the head count limit is set for a person role.
      Returns:
      boolean flag

    • setHeadCountLimitSet

      public void setHeadCountLimitSet(boolean headCountLimitSet)
      Set up the indicator whether the head count limit is set for a person role.
      Parameters:
      headCountLimitSet - boolean flag

    • getHeadCount

      public int getHeadCount()
      Return the number of people that can be appointed to this role.
      Returns:
      int

    • setHeadCount

      public void setHeadCount(int headCount)
      Set up the number of people that can be appointed to this role.
      Parameters:
      headCount - int

    • getAdditionalProperties

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

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up additional properties.
      Parameters:
      additionalProperties - Additional properties object

    • 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