GroupData (OMERO API)

java.lang.Object
- omero.gateway.model.DataObject
- - omero.gateway.model.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

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT` Identifies the `default` group.
`static String`	`DESCRIPTION` Identifies the `ExperimenterGroupI.DESCRIPTION` field.
`static String`	`GROUP_EXPERIMENTER_MAP` Identifies the `ExperimenterGroupI.GROUPEXPERIMENTERMAP` field.
`static String`	`GUEST` Identifies the `Guest` group.
`static String`	`NAME` Identifies the `ExperimenterGroupI.NAME` field.
`static int`	`PERMISSIONS_GROUP_READ` Indicates that the group is `Group` i.e.
`static int`	`PERMISSIONS_GROUP_READ_LINK` Indicates that the group is `Group` i.e.
`static String`	`PERMISSIONS_GROUP_READ_LINK_SHORT_TEXT` Indicates that the group is `Group` i.e.
`static String`	`PERMISSIONS_GROUP_READ_LINK_TEXT` Indicates that the group is `Group` i.e.
`static String`	`PERMISSIONS_GROUP_READ_SHORT_TEXT` Indicates that the group is `Group` i.e.
`static String`	`PERMISSIONS_GROUP_READ_TEXT` Indicates that the group is `Group` i.e.
`static int`	`PERMISSIONS_GROUP_READ_WRITE` Indicates that the group is `Group` i.e.
`static String`	`PERMISSIONS_GROUP_READ_WRITE_SHORT_TEXT` Indicates that the group is `Group` i.e.
`static String`	`PERMISSIONS_GROUP_READ_WRITE_TEXT` Indicates that the group is `Group` i.e.
`static int`	`PERMISSIONS_PRIVATE` Indicates that the group is `Private` i.e.
`static String`	`PERMISSIONS_PRIVATE_TEXT` Indicates that the group is `Private` i.e.
`static int`	`PERMISSIONS_PUBLIC_READ` Indicates that the group is `Public` i.e.
`static String`	`PERMISSIONS_PUBLIC_READ_TEXT` Indicates that the group is `Public` i.e.
`static int`	`PERMISSIONS_PUBLIC_READ_WRITE` Indicates that the group is `Public` i.e.
`static String`	`PERMISSIONS_PUBLIC_READ_WRITE_TEXT` Indicates that the group is `Public` i.e.
`static String`	`SYSTEM` Identifies the `System` group.
`static String`	`USER` Identifies the `User` group.

Constructor Summary

Constructors
Constructor and Description

GroupData()
Creates a new instance.

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

Constructors
Constructor and Description
`GroupData()` Creates a new instance.
`GroupData(omero.model.ExperimenterGroup group)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Returns the description of the group.
`Set<ExperimenterData>`	`getExperimenters()` Returns the experimenters contained in this group.
`long`	`getGroupId()` Overridden to return the id of the object.
`Set<ExperimenterData>`	`getLeaders()` Returns the experimenters contained in this group.
`Set<ExperimenterData>`	`getMembersOnly()` Returns the list of experimenters that are not owners of the 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 omero.gateway.model.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, 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
  - PERMISSIONS_PRIVATE
```
public static final int PERMISSIONS_PRIVATE
```
    Indicates that the group is Private i.e. RW----.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ
```
public static final int PERMISSIONS_GROUP_READ
```
    Indicates that the group is Group i.e. RWR---.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_LINK
```
public static final int PERMISSIONS_GROUP_READ_LINK
```
    Indicates that the group is Group i.e. RWRA--.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_WRITE
```
public static final int PERMISSIONS_GROUP_READ_WRITE
```
    Indicates that the group is Group i.e. RWRW--.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_PUBLIC_READ
```
public static final int PERMISSIONS_PUBLIC_READ
```
    Indicates that the group is Public i.e. RWRWR-.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_PUBLIC_READ_WRITE
```
public static final int PERMISSIONS_PUBLIC_READ_WRITE
```
    Indicates that the group is Public i.e. RWRWRW.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_PRIVATE_TEXT
```
public static final String PERMISSIONS_PRIVATE_TEXT
```
    Indicates that the group is Private i.e. RW----.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_TEXT
```
public static final String PERMISSIONS_GROUP_READ_TEXT
```
    Indicates that the group is Group i.e. RWR---.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_LINK_TEXT
```
public static final String PERMISSIONS_GROUP_READ_LINK_TEXT
```
    Indicates that the group is Group i.e. RWRA--.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_WRITE_TEXT
```
public static final String PERMISSIONS_GROUP_READ_WRITE_TEXT
```
    Indicates that the group is Group i.e. RWRW--.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_PUBLIC_READ_TEXT
```
public static final String PERMISSIONS_PUBLIC_READ_TEXT
```
    Indicates that the group is Public i.e. RWRWR-.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_PUBLIC_READ_WRITE_TEXT
```
public static final String PERMISSIONS_PUBLIC_READ_WRITE_TEXT
```
    Indicates that the group is Public i.e. RWRWRW.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_SHORT_TEXT
```
public static final String PERMISSIONS_GROUP_READ_SHORT_TEXT
```
    Indicates that the group is Group i.e. RWR---.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_LINK_SHORT_TEXT
```
public static final String PERMISSIONS_GROUP_READ_LINK_SHORT_TEXT
```
    Indicates that the group is Group i.e. RWRA--.
    
    See Also:
    
    Constant Field Values
  - PERMISSIONS_GROUP_READ_WRITE_SHORT_TEXT
```
public static final String PERMISSIONS_GROUP_READ_WRITE_SHORT_TEXT
```
    Indicates that the group is Group i.e. RWRW--.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Identifies the ExperimenterGroupI.NAME field.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final String DESCRIPTION
```
    Identifies the ExperimenterGroupI.DESCRIPTION field.
    
    See Also:
    
    Constant Field Values
  - GROUP_EXPERIMENTER_MAP
```
public static final String GROUP_EXPERIMENTER_MAP
```
    Identifies the ExperimenterGroupI.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<ExperimenterData> getLeaders()
```
    Returns the experimenters contained in this group.
    
    Returns:
    
    See above.
  - getExperimenters
```
public Set<ExperimenterData> getExperimenters()
```
    Returns the experimenters contained in this group.
    
    Returns:
    
    See above.
  - getMembersOnly
```
public Set<ExperimenterData> getMembersOnly()
```
    Returns the list of experimenters that are not owners of the group.
    
    Returns:
    
    See above.
  - getGroupId
```
public long getGroupId()
```
    Overridden to return the id of the object.
    
    Overrides:
    
    getGroupId in class DataObject
    
    Returns:
    
    See above.
    
    See Also:
    
    DataObject.getGroupId()
  - setExperimenters
```
public void setExperimenters(Set<ExperimenterData> newValue)
```
    Sets the experimenters contained in this group.
    
    Parameters:
    
    newValue - The set of experimenters.

Class GroupData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

PERMISSIONS_PRIVATE

PERMISSIONS_GROUP_READ

PERMISSIONS_GROUP_READ_LINK

PERMISSIONS_GROUP_READ_WRITE

PERMISSIONS_PUBLIC_READ

PERMISSIONS_PUBLIC_READ_WRITE

PERMISSIONS_PRIVATE_TEXT

PERMISSIONS_GROUP_READ_TEXT

PERMISSIONS_GROUP_READ_LINK_TEXT

PERMISSIONS_GROUP_READ_WRITE_TEXT

PERMISSIONS_PUBLIC_READ_TEXT

PERMISSIONS_PUBLIC_READ_WRITE_TEXT

PERMISSIONS_GROUP_READ_SHORT_TEXT

PERMISSIONS_GROUP_READ_LINK_SHORT_TEXT

PERMISSIONS_GROUP_READ_WRITE_SHORT_TEXT

NAME

DESCRIPTION

GROUP_EXPERIMENTER_MAP

USER

SYSTEM

GUEST

DEFAULT

Constructor Detail

GroupData

GroupData

Method Detail

getName

setName

getDescription

setDescription

getLeaders

getExperimenters

getMembersOnly

getGroupId

setExperimenters