org.dataone.service.types.v1

Class Group

java.lang.Object

org.dataone.service.types.v1.Group

All Implemented Interfaces:

Serializable

public class Group
extends Object
implements Serializable

Group represents metadata about a :term:`Subject` that represents a collection of other Subjects. Groups provide a convenient mechanism to express access rules for certain roles that are not necessarily tied to particular :term:`principals` over time. 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="Group">
   <xs:sequence>
     <xs:element type="ns:Subject" name="subject" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="groupName" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:Subject" name="hasMember" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:Subject" name="rightsHolder" minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	groupName
protected List<Subject>	hasMember
protected List<Subject>	rightsHolder
protected Subject	subject

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHasMember(Subject item) Add a 'hasMember' element item.
void	addRightsHolder(Subject item) Add a 'rightsHolder' element item.
void	clearHasMemberList() Remove all 'hasMember' element items.
void	clearRightsHolderList() Remove all 'rightsHolder' element items.
String	getGroupName() Get the 'groupName' element value.
Subject	getHasMember(int index) Get 'hasMember' element item by position.
List<Subject>	getHasMemberList() Get the list of 'hasMember' element items.
Subject	getRightsHolder(int index) Get 'rightsHolder' element item by position.
List<Subject>	getRightsHolderList() Get the list of 'rightsHolder' element items.
Subject	getSubject() Get the 'subject' element value.
void	setGroupName(String groupName) Set the 'groupName' element value.
void	setHasMemberList(List<Subject> list) Set the list of 'hasMember' element items.
void	setRightsHolderList(List<Subject> list) Set the list of 'rightsHolder' element items.
void	setSubject(Subject subject) Set the 'subject' element value.
int	sizeHasMemberList() Get the number of 'hasMember' element items.
int	sizeRightsHolderList() Get the number of 'rightsHolder' element items.

Methods inherited from class java.lang.Object

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

Field Detail

subject

protected Subject subject

groupName

protected String groupName

hasMember

protected List<Subject> hasMember

rightsHolder

protected List<Subject> rightsHolder

Constructor Detail

Group

public Group()

Method Detail

getSubject

public Subject getSubject()

Get the 'subject' element value. The unique, immutable identifier of the :term:`group`. Group subjects must not be reused, and so they are both immutable and can not be deleted from the DataONE system.

Returns:

value

setSubject

public void setSubject(Subject subject)

Set the 'subject' element value. The unique, immutable identifier of the :term:`group`. Group subjects must not be reused, and so they are both immutable and can not be deleted from the DataONE system.

Parameters:

subject -

getGroupName

public String getGroupName()

Get the 'groupName' element value. The name of the Group.

Returns:

value

setGroupName

public void setGroupName(String groupName)

Set the 'groupName' element value. The name of the Group.

Parameters:

groupName -

getHasMemberList

public List<Subject> getHasMemberList()

Get the list of 'hasMember' element items. A :term:`Subject` that is a member of this group, expressed using the unique identifier for that Subject.

Returns:

list

setHasMemberList

public void setHasMemberList(List<Subject> list)

Set the list of 'hasMember' element items. A :term:`Subject` that is a member of this group, expressed using the unique identifier for that Subject.

Parameters:

list -

sizeHasMemberList

public int sizeHasMemberList()

Get the number of 'hasMember' element items.

Returns:

count

addHasMember

public void addHasMember(Subject item)

Add a 'hasMember' element item.

Parameters:

item -

getHasMember

public Subject getHasMember(int index)

Get 'hasMember' element item by position.

Parameters:

index -

Returns:

item

clearHasMemberList

public void clearHasMemberList()

Remove all 'hasMember' element items.

getRightsHolderList

public List<Subject> getRightsHolderList()

Get the list of 'rightsHolder' element items. Represents the list of owners of this :term:`group`. All groups are readable by anyone in the DataONE system, but can only be modified by subjects listed in *rightsHolder* fields. Designation as a :term:`rightsHolder` allows the subject, or their equivalent identities, to make changes to the mutable properties of the group, including its name, membership list and rights holder list. The subject of the group itself is immutable.

Returns:

list

setRightsHolderList

public void setRightsHolderList(List<Subject> list)

Set the list of 'rightsHolder' element items. Represents the list of owners of this :term:`group`. All groups are readable by anyone in the DataONE system, but can only be modified by subjects listed in *rightsHolder* fields. Designation as a :term:`rightsHolder` allows the subject, or their equivalent identities, to make changes to the mutable properties of the group, including its name, membership list and rights holder list. The subject of the group itself is immutable.

Parameters:

list -

sizeRightsHolderList

public int sizeRightsHolderList()

Get the number of 'rightsHolder' element items.

Returns:

count

addRightsHolder

public void addRightsHolder(Subject item)

Add a 'rightsHolder' element item.

Parameters:

item -

getRightsHolder

public Subject getRightsHolder(int index)

Get 'rightsHolder' element item by position.

Parameters:

index -

Returns:

item

clearRightsHolderList

public void clearRightsHolderList()

Remove all 'rightsHolder' element items.