Class PersonalRoleProperties
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.securitymanager.properties.PersonalRoleProperties
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
PersonRoleProperties
public class PersonalRoleProperties extends Object implements Serializable
PersonalRoleProperties provides a structure for describe a role assigned to a person.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PersonalRoleProperties()Default constructorPersonalRoleProperties(PersonalRoleProperties template)Copy/clone constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Equals method that returns true if containing properties are the same.Map<String,String>getAdditionalProperties()Return a copy of the additional properties.StringgetDescription()Return the description of the job role for this governance appointment.DategetEffectiveFrom()Return the date/time that this element is effective from (null means effective from the epoch).DategetEffectiveTo()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.StringgetRoleId()Return the unique identifier for this job role/appointment.StringgetScope()Return the context in which the governance officer is appointed.StringgetTitle()Return the job role title.StringgetTypeName()Return the open metadata type name of this object - this is used to create a subtype of the referenceable.inthashCode()Return hash code for this objectvoidsetAdditionalProperties(Map<String,String> additionalProperties)Set up additional properties.voidsetDescription(String description)Set up the description of the job role for this governance officer.voidsetEffectiveFrom(Date effectiveFrom)Set up the date/time that this element is effective from (null means effective from the epoch).voidsetEffectiveTo(Date effectiveTo)Set the date/time that element is effective to (null means that it is effective indefinitely into the future).voidsetExtendedProperties(Map<String,Object> extendedProperties)Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.voidsetRoleId(String roleId)Set up the unique identifier for this job role/appointment.voidsetScope(String scope)Set up the context in which the governance officer is appointed.voidsetTitle(String title)Set up the job role title.voidsetTypeName(String typeName)Set up the open metadata type name of this object - this is used to create a subtype of the referenceable.StringtoString()JSON-style toString.
-
-
-
Constructor Detail
-
PersonalRoleProperties
public PersonalRoleProperties()
Default constructor
-
PersonalRoleProperties
public PersonalRoleProperties(PersonalRoleProperties template)
Copy/clone constructor- Parameters:
template- object to copy
-
-
Method Detail
-
getRoleId
public String getRoleId()
Return the unique identifier for this job role/appointment.- Returns:
- unique name
-
setRoleId
public void setRoleId(String roleId)
Set up the unique identifier for this job role/appointment.- Parameters:
roleId- unique name
-
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
-
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.
-
equals
public boolean equals(Object objectToCompare)
Equals method that returns true if containing properties are the same.
-
-