com.unboundid.scim.data

Class Name

java.lang.Object

com.unboundid.scim.data.Name

public class Name
extends Object

A complex type containing the components of the User's real name.

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeValueResolver<Name>	NAME_RESOLVER The AttributeValueResolver that resolves SCIM attribute values to/from Name instances.

Constructor Summary

Constructors

Constructor and Description
Name(String formatted, String familyName, String middleName, String givenName, String honorificPrefix, String honorificSuffix) Creates a SCIM core user 'name' attribute.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getFamilyName() Retrieves the family name of the User, or "Last Name" in most Western languages.
String	getFormatted() Retrieves the full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
String	getGivenName() Retrieves the given name of the User, or "First Name" in most Western languages.
String	getHonorificPrefix() Retrieves the honorific prefix(es) of the User, or "Title" in most Western languages.
String	getHonorificSuffix() Retrieves the honorific suffix(es) of the User, or "Suffix" in most Western languages.
String	getMiddleName() Retrieves the middle name(s) of the User.
int	hashCode()
void	setFamilyName(String familyName) Sets the family name of the User, or "Last Name" in most Western languages.
void	setFormatted(String formatted) Sets the full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
void	setGivenName(String givenName) Sets the given name of the User, or "First Name" in most Western languages.
void	setHonorificPrefix(String honorificPrefix) Sets the honorific prefix(es) of the User, or "Title" in most Western languages.
void	setHonorificSuffix(String honorificSuffix) Sets the honorific suffix(es) of the User, or "Suffix" in most Western languages.
void	setMiddleName(String middleName) Retrieves the middle name(s) of the User.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NAME_RESOLVER

public static final AttributeValueResolver<Name> NAME_RESOLVER

The AttributeValueResolver that resolves SCIM attribute values to/from Name instances.

Constructor Detail

Name

public Name(String formatted,
    String familyName,
    String middleName,
    String givenName,
    String honorificPrefix,
    String honorificSuffix)

Creates a SCIM core user 'name' attribute. Any of the arguments may be null if they are not to be included.

Parameters:

formatted - The The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

familyName - The family name of the User, or "Last Name" in most Western languages.

givenName - The given name of the User, or "First Name" in most Western languages.

middleName - The middle name(s) of the User.

honorificPrefix - The honorific prefix(es) of the User, or "Title" in most Western languages.

honorificSuffix - The honorifix suffix(es) of the User, or "Suffix" in most Western languages.

Method Detail

getFamilyName

public String getFamilyName()

Retrieves the family name of the User, or "Last Name" in most Western languages.

Returns:

The family name of the User, or "Last Name" in most Western languages.

setFamilyName

public void setFamilyName(String familyName)

Sets the family name of the User, or "Last Name" in most Western languages.

Parameters:

familyName - The family name of the User, or "Last Name" in most Western languages.

getFormatted

public String getFormatted()

Retrieves the full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

Returns:

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

setFormatted

public void setFormatted(String formatted)

Sets the full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

Parameters:

formatted - The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

getGivenName

public String getGivenName()

Retrieves the given name of the User, or "First Name" in most Western languages.

Returns:

The given name of the User, or "First Name" in most Western languages.

setGivenName

public void setGivenName(String givenName)

Sets the given name of the User, or "First Name" in most Western languages.

Parameters:

givenName - The given name of the User, or "First Name" in most Western languages.

getHonorificPrefix

public String getHonorificPrefix()

Retrieves the honorific prefix(es) of the User, or "Title" in most Western languages.

Returns:

The honorific prefix(es) of the User, or "Title" in most Western languages.

setHonorificPrefix

public void setHonorificPrefix(String honorificPrefix)

Sets the honorific prefix(es) of the User, or "Title" in most Western languages.

Parameters:

honorificPrefix - The honorific prefix(es) of the User, or "Title" in most Western languages.

getHonorificSuffix

public String getHonorificSuffix()

Retrieves the honorific suffix(es) of the User, or "Suffix" in most Western languages.

Returns:

The honorific suffix(es) of the User, or "Suffix" in most Western languages.

setHonorificSuffix

public void setHonorificSuffix(String honorificSuffix)

Sets the honorific suffix(es) of the User, or "Suffix" in most Western languages.

Parameters:

honorificSuffix - The honorific suffix(es) of the User, or "Suffix" in most Western languages.

getMiddleName

public String getMiddleName()

Retrieves the middle name(s) of the User.

Returns:

The middle name(s) of the User.

setMiddleName

public void setMiddleName(String middleName)

Retrieves the middle name(s) of the User.

Parameters:

middleName - The middle name(s) of the User.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object