Class MyProfileRequestBody
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityProfileOMASAPIRequestBody
-
- org.odpi.openmetadata.accessservices.communityprofile.rest.MyProfileRequestBody
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
PersonalProfileRequestBody
public class MyProfileRequestBody extends CommunityProfileOMASAPIRequestBody
MyProfileRequestBody provides a structure for passing personal details over a REST API. It is used for creating and updating a profile for the calling user.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description MyProfileRequestBody()Default constructorMyProfileRequestBody(MyProfileRequestBody 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.StringgetFullName()Return the full name for this person.StringgetJobRoleDescription()Return the description of the job role for this person.StringgetJobTitle()Return the primary job title for this person.StringgetKnownName()Return the preferred name for this person.Map<String,Object>getProfileProperties()Return profile properties.StringgetQualifiedName()Return the unique name for this person - may be employee identifier.inthashCode()Return hash code for this objectvoidsetAdditionalProperties(Map<String,String> additionalProperties)Set up additional properties.voidsetFullName(String fullName)Set up the full name for this person.voidsetJobRoleDescription(String jobRoleDescription)Set up the description of the job role for this person.voidsetJobTitle(String jobTitle)Set up the primary job title for this person.voidsetKnownName(String knownName)Set up the preferred name for this person.voidsetProfileProperties(Map<String,Object> profileProperties)Set up profile properties.voidsetQualifiedName(String qualifiedName)Set up the unique name for this person - may be employee identifier.StringtoString()JSON-style toString.
-
-
-
Constructor Detail
-
MyProfileRequestBody
public MyProfileRequestBody()
Default constructor
-
MyProfileRequestBody
public MyProfileRequestBody(MyProfileRequestBody template)
Copy/clone constructor- Parameters:
template- object to copy
-
-
Method Detail
-
getQualifiedName
public String getQualifiedName()
Return the unique name for this person - may be employee identifier.- Returns:
- String identifier
-
setQualifiedName
public void setQualifiedName(String qualifiedName)
Set up the unique name for this person - may be employee identifier.- Parameters:
qualifiedName- String identifier
-
getFullName
public String getFullName()
Return the full name for this person.- Returns:
- string name
-
setFullName
public void setFullName(String fullName)
Set up the full name for this person.- Parameters:
fullName- string name
-
getKnownName
public String getKnownName()
Return the preferred name for this person.- Returns:
- string name
-
setKnownName
public void setKnownName(String knownName)
Set up the preferred name for this person.- Parameters:
knownName- string name
-
getJobTitle
public String getJobTitle()
Return the primary job title for this person. 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 title
-
setJobTitle
public void setJobTitle(String jobTitle)
Set up the primary job title for this person. 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:
jobTitle- string title
-
getJobRoleDescription
public String getJobRoleDescription()
Return the description of the job role for this person. 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
-
setJobRoleDescription
public void setJobRoleDescription(String jobRoleDescription)
Set up the description of the job role for this person. 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:
jobRoleDescription- string description
-
setProfileProperties
public void setProfileProperties(Map<String,Object> profileProperties)
Set up profile properties. These are properties that come from the subclass of Person. Null means no profile properties are available.- Parameters:
profileProperties- map from string (property name) to object (property value)
-
getProfileProperties
public Map<String,Object> getProfileProperties()
Return profile properties. These are properties that come from the subclass of Person. Null means no profile properties are available.- Returns:
- map from string (property name) to object (property value)
-
setAdditionalProperties
public void setAdditionalProperties(Map<String,String> additionalProperties)
Set up additional properties.- Parameters:
additionalProperties- Additional properties object
-
getAdditionalProperties
public Map<String,String> getAdditionalProperties()
Return a copy of the additional properties. Null means no additional properties are available.- Returns:
- AdditionalProperties
-
toString
public String toString()
JSON-style toString.- Overrides:
toStringin classCommunityProfileOMASAPIRequestBody- Returns:
- list of properties and their values.
-
equals
public boolean equals(Object objectToCompare)
Equals method that returns true if containing properties are the same.
-
-