pojos
Class GroupData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.GroupData

public class GroupData
extends DataObject

The data that makes up an OME Group along with the various members of the Group

Since:
OME2.2
Version:
2.2 (Internal version: $Revision$ $Date$)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk,
Andrea Falconi      a.falconi@dundee.ac.uk

Field Summary
static String DEFAULT
          Identifies the default group.
static String DESCRIPTION
          Identifies the ExperimenterGroup#DESCRIPTION field.
static String GROUP_EXPERIMENTER_MAP
          Identifies the ExperimenterGroup#GROUPEXPERIMENTERMAP field.
static String GUEST
          Identifies the Guest group.
static String NAME
          Identifies the ExperimenterGroup#NAME field.
static String SYSTEM
          Identifies the System group.
static String USER
          Identifies the User group.
 
Constructor Summary
GroupData()
          Creates a new instance.
GroupData(omero.model.ExperimenterGroup group)
          Creates a new instance.
 
Method Summary
 String getDescription()
          Returns the description of the group.
 Set getExperimenters()
          Returns the experimenters contained in this group.
 Set getLeaders()
          Returns the experimenters contained in this group.
 String getName()
          Returns the name of the group.
 void setDescription(String description)
          Sets the name of the group.
 void setExperimenters(Set<ExperimenterData> newValue)
          Sets the experimenters contained in this group.
 void setName(String name)
          Sets the name of the group.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
Identifies the ExperimenterGroup#NAME field.

See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
Identifies the ExperimenterGroup#DESCRIPTION field.

See Also:
Constant Field Values

GROUP_EXPERIMENTER_MAP

public static final String GROUP_EXPERIMENTER_MAP
Identifies the ExperimenterGroup#GROUPEXPERIMENTERMAP field.

See Also:
Constant Field Values

USER

public static final String USER
Identifies the User group.

See Also:
Constant Field Values

SYSTEM

public static final String SYSTEM
Identifies the System group.

See Also:
Constant Field Values

GUEST

public static final String GUEST
Identifies the Guest group.

See Also:
Constant Field Values

DEFAULT

public static final String DEFAULT
Identifies the default group.

See Also:
Constant Field Values
Constructor Detail

GroupData

public GroupData()
Creates a new instance.


GroupData

public GroupData(omero.model.ExperimenterGroup group)
Creates a new instance.

Parameters:
group - Back pointer to the ExperimenterGroup model object. Mustn't be null.
Throws:
IllegalArgumentException - If the object is null.
Method Detail

getName

public String getName()
Returns the name of the group.

Returns:
See above.

setName

public void setName(String name)
Sets the name of the group.

Parameters:
name - The name of the group. Mustn't be null.
Throws:
IllegalArgumentException - If the name is null.

getDescription

public String getDescription()
Returns the description of the group.

Returns:
See above.

setDescription

public void setDescription(String description)
Sets the name of the group.

Parameters:
description - The description of the group. Mustn't be null.
Throws:
IllegalArgumentException - If the name is null.

getLeaders

public Set getLeaders()
Returns the experimenters contained in this group.

Returns:
See above.

getExperimenters

public Set getExperimenters()
Returns the experimenters contained in this group.

Returns:
See above.

setExperimenters

public void setExperimenters(Set<ExperimenterData> newValue)
Sets the experimenters contained in this group.

Parameters:
newValue - The set of experimenters.


OmeroJava Api

Version: 4.3.3-00d1137e-b2894

Copyright © 2009 The University of Dundee. All Rights Reserved.