org.dataone.service.types.v1

Class Subject

java.lang.Object

org.dataone.service.types.v1.Subject

All Implemented Interfaces:

Serializable, Comparable

public class Subject
extends Object
implements Serializable, Comparable

An identifier for a Person (user), Group, Organization, or System.The :term:`Subject` is a string that provides a formal name to identify a user or group in the DataONE Identity Management Service. The *subject* is represented by a unique, persistent, non-reassignable identifier string that follows the same constraints as :class:`Types.Identifier`. Subjects are immutable and can not be deleted. 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="Subject">
   <xs:simpleContent>
     <xs:extension base="xs:string"/>
   </xs:simpleContent>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	value

Constructor Summary

Constructors

Constructor and Description
Subject()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Object other) Compares order based on the String value of two objects of the same type.
boolean	equals(Object other) Value is a string, override equals of Subject.
String	getValue() Get the 'Subject' complexType value.
int	hashCode() return the hashcode of Subject's string value.
void	setValue(String value) Set the 'Subject' complexType value.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected String value

Constructor Detail

Subject

public Subject()

Method Detail

getValue

public String getValue()

Get the 'Subject' complexType value.

Returns:

value

setValue

public void setValue(String value)

Set the 'Subject' complexType value.

Parameters:

value -

equals

public boolean equals(Object other)

Value is a string, override equals of Subject.

Overrides:

equals in class Object

Parameters:

other -

Returns:

boolean

hashCode

public int hashCode()

return the hashcode of Subject's string value.

Overrides:

hashCode in class Object

Returns:

int

compareTo

public int compareTo(Object other)
              throws ClassCastException

Compares order based on the String value of two objects of the same type.

Specified by:

compareTo in interface Comparable

Parameters:

other -

Returns:

int

Throws:

ClassCastException