org.dataone.service.types.v1

Class Person

java.lang.Object

org.dataone.service.types.v1.Person

All Implemented Interfaces:

Serializable

public class Person
extends Object
implements Serializable

*Person* represents metadata about a :term:`Principal` that is a person and that can be used by clients and nodes for :class:`Types.AccessPolicy` information. The mutable properties of a Person* instance can only be changed by itself (i.e., the Subject identifying the Person instance) and by the Coordinating Node identity, but can be read by any identity in the DataONE system. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Person">
   <xs:sequence>
     <xs:element type="ns:Subject" name="subject" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="givenName" minOccurs="1" maxOccurs="unbounded"/>
     <xs:element type="xs:string" name="familyName" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="email" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:Subject" name="isMemberOf" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:Subject" name="equivalentIdentity" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="xs:boolean" name="verified" minOccurs="0" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Person()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEmail(String item) Add a 'email' element item.
void	addEquivalentIdentity(Subject item) Add a 'equivalentIdentity' element item.
void	addGivenName(String item) Add a 'givenName' element item.
void	addIsMemberOf(Subject item) Add a 'isMemberOf' element item.
void	clearEmailList() Remove all 'email' element items.
void	clearEquivalentIdentityList() Remove all 'equivalentIdentity' element items.
void	clearGivenNameList() Remove all 'givenName' element items.
void	clearIsMemberOfList() Remove all 'isMemberOf' element items.
String	getEmail(int index) Get 'email' element item by position.
List<String>	getEmailList() Get the list of 'email' element items.
Subject	getEquivalentIdentity(int index) Get 'equivalentIdentity' element item by position.
List<Subject>	getEquivalentIdentityList() Get the list of 'equivalentIdentity' element items.
String	getFamilyName() Get the 'familyName' element value.
String	getGivenName(int index) Get 'givenName' element item by position.
List<String>	getGivenNameList() Get the list of 'givenName' element items.
Subject	getIsMemberOf(int index) Get 'isMemberOf' element item by position.
List<Subject>	getIsMemberOfList() Get the list of 'isMemberOf' element items.
Subject	getSubject() Get the 'subject' element value.
Boolean	getVerified() Get the 'verified' element value.
void	setEmailList(List<String> list) Set the list of 'email' element items.
void	setEquivalentIdentityList(List<Subject> list) Set the list of 'equivalentIdentity' element items.
void	setFamilyName(String familyName) Set the 'familyName' element value.
void	setGivenNameList(List<String> list) Set the list of 'givenName' element items.
void	setIsMemberOfList(List<Subject> list) Set the list of 'isMemberOf' element items.
void	setSubject(Subject subject) Set the 'subject' element value.
void	setVerified(Boolean verified) Set the 'verified' element value.
int	sizeEmailList() Get the number of 'email' element items.
int	sizeEquivalentIdentityList() Get the number of 'equivalentIdentity' element items.
int	sizeGivenNameList() Get the number of 'givenName' element items.
int	sizeIsMemberOfList() Get the number of 'isMemberOf' element items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Person

public Person()

Method Detail

getSubject

public Subject getSubject()

Get the 'subject' element value. The unique, immutable identifier for the Person*.

Returns:

value

setSubject

public void setSubject(Subject subject)

Set the 'subject' element value. The unique, immutable identifier for the Person*.

Parameters:

subject -

getGivenNameList

public List<String> getGivenNameList()

Get the list of 'givenName' element items. The given name of the *Person*, repeatable if they have more than one given name.

Returns:

list

setGivenNameList

public void setGivenNameList(List<String> list)

Set the list of 'givenName' element items. The given name of the *Person*, repeatable if they have more than one given name.

Parameters:

list -

sizeGivenNameList

public int sizeGivenNameList()

Get the number of 'givenName' element items.

Returns:

count

addGivenName

public void addGivenName(String item)

Add a 'givenName' element item.

Parameters:

item -

getGivenName

public String getGivenName(int index)

Get 'givenName' element item by position.

Parameters:

index -

Returns:

item

clearGivenNameList

public void clearGivenNameList()

Remove all 'givenName' element items.

getFamilyName

public String getFamilyName()

Get the 'familyName' element value. The family name of the *Person*.

Returns:

value

setFamilyName

public void setFamilyName(String familyName)

Set the 'familyName' element value. The family name of the *Person*.

Parameters:

familyName -

getEmailList

public List<String> getEmailList()

Get the list of 'email' element items. The email address of the *Person*, repeatable if they have more than one email address.

Returns:

list

setEmailList

public void setEmailList(List<String> list)

Set the list of 'email' element items. The email address of the *Person*, repeatable if they have more than one email address.

Parameters:

list -

sizeEmailList

public int sizeEmailList()

Get the number of 'email' element items.

Returns:

count

addEmail

public void addEmail(String item)

Add a 'email' element item.

Parameters:

item -

getEmail

public String getEmail(int index)

Get 'email' element item by position.

Parameters:

index -

Returns:

item

clearEmailList

public void clearEmailList()

Remove all 'email' element items.

getIsMemberOfList

public List<Subject> getIsMemberOfList()

Get the list of 'isMemberOf' element items. A *group* or role in which the *Person* is a member, expressed using the unique :class:`Types.Subject` identifier for that :class:`Types.Group`, and repeatable if they are a member of more than one group.

Returns:

list

setIsMemberOfList

public void setIsMemberOfList(List<Subject> list)

Set the list of 'isMemberOf' element items. A *group* or role in which the *Person* is a member, expressed using the unique :class:`Types.Subject` identifier for that :class:`Types.Group`, and repeatable if they are a member of more than one group.

Parameters:

list -

sizeIsMemberOfList

public int sizeIsMemberOfList()

Get the number of 'isMemberOf' element items.

Returns:

count

addIsMemberOf

public void addIsMemberOf(Subject item)

Add a 'isMemberOf' element item.

Parameters:

item -

getIsMemberOf

public Subject getIsMemberOf(int index)

Get 'isMemberOf' element item by position.

Parameters:

index -

Returns:

item

clearIsMemberOfList

public void clearIsMemberOfList()

Remove all 'isMemberOf' element items.

getEquivalentIdentityList

public List<Subject> getEquivalentIdentityList()

Get the list of 'equivalentIdentity' element items. An alternative but equivalent identity for the :term:`principal` that has been used in alternate identity systems, repeatable if more than one equivalent identity applies.

Returns:

list

setEquivalentIdentityList

public void setEquivalentIdentityList(List<Subject> list)

Set the list of 'equivalentIdentity' element items. An alternative but equivalent identity for the :term:`principal` that has been used in alternate identity systems, repeatable if more than one equivalent identity applies.

Parameters:

list -

sizeEquivalentIdentityList

public int sizeEquivalentIdentityList()

Get the number of 'equivalentIdentity' element items.

Returns:

count

addEquivalentIdentity

public void addEquivalentIdentity(Subject item)

Add a 'equivalentIdentity' element item.

Parameters:

item -

getEquivalentIdentity

public Subject getEquivalentIdentity(int index)

Get 'equivalentIdentity' element item by position.

Parameters:

index -

Returns:

item

clearEquivalentIdentityList

public void clearEquivalentIdentityList()

Remove all 'equivalentIdentity' element items.

getVerified

public Boolean getVerified()

Get the 'verified' element value. *true* if the name and email address of the Person* have been :term:`verified` to ensure that the *givenName* and *familyName* represent the real person's legal name, and that the email address is correct for that person and is in the control of the indicated individual. Verification occurs through an established procedure within DataONE as part of the Identity Management system. A Person can not change their own *verified* field, but rather must be verified and changed through this DataONE established process.

Returns:

value

setVerified

public void setVerified(Boolean verified)

Set the 'verified' element value. *true* if the name and email address of the Person* have been :term:`verified` to ensure that the *givenName* and *familyName* represent the real person's legal name, and that the email address is correct for that person and is in the control of the indicated individual. Verification occurs through an established procedure within DataONE as part of the Identity Management system. A Person can not change their own *verified* field, but rather must be verified and changed through this DataONE established process.

Parameters:

verified -