Package fr.igred.omero.meta

Interface Group

All Superinterfaces:

RemoteObject

All Known Implementing Classes:

GroupWrapper

public interface Group
extends RemoteObject

Interface to handle Groups on OMERO.

Field Summary

Fields

Modifier and Type	Field	Description
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 int	PERMISSIONS_GROUP_READ_WRITE	Indicates that the group is Group i.e.
static int	PERMISSIONS_PRIVATE	Indicates that the group is Private i.e.
static int	PERMISSIONS_PUBLIC_READ	Indicates that the group is Public i.e.
static int	PERMISSIONS_PUBLIC_READ_WRITE	Indicates that the group is Public i.e.

Method Summary

Modifier and Type	Method	Description
GroupData	asDataObject()	Returns a GroupData corresponding to the handled object.
java.lang.String	getDescription()	Returns the description of the group.
java.util.List<Experimenter>	getExperimenters()	Returns the experimenters contained in this group.
java.util.List<Experimenter>	getLeaders()	Returns the leaders of this group.
java.util.List<Experimenter>	getMembersOnly()	Returns the list of experimenters that are not owners of the group.
java.lang.String	getName()	Returns the name of the group.
int	getPermissionsLevel()	Returns the permissions level.
void	setDescription(java.lang.String description)	Sets the description of the group.
void	setName(java.lang.String name)	Sets the name of the group.

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Field Detail

PERMISSIONS_PRIVATE

static final int PERMISSIONS_PRIVATE

Indicates that the group is Private i.e. RW----.

See Also:

Constant Field Values

PERMISSIONS_GROUP_READ

static final int PERMISSIONS_GROUP_READ

Indicates that the group is Group i.e. RWR---.

See Also:

Constant Field Values

PERMISSIONS_GROUP_READ_LINK

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

static final int PERMISSIONS_GROUP_READ_WRITE

Indicates that the group is Group i.e. RWRW--.

See Also:

Constant Field Values

PERMISSIONS_PUBLIC_READ

static final int PERMISSIONS_PUBLIC_READ

Indicates that the group is Public i.e. RWRWR-.

See Also:

Constant Field Values

PERMISSIONS_PUBLIC_READ_WRITE

static final int PERMISSIONS_PUBLIC_READ_WRITE

Indicates that the group is Public i.e. RWRWRW.

See Also:

Constant Field Values

Method Detail

asDataObject

GroupData asDataObject()

Returns a GroupData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getName

java.lang.String getName()

Returns the name of the group.

Returns:

See above.

setName

void setName(java.lang.String name)

Sets the name of the group.

Parameters:

name - The name of the group. Mustn't be null.

Throws:

java.lang.IllegalArgumentException - If the name is null.

getDescription

java.lang.String getDescription()

Returns the description of the group.

Returns:

See above.

setDescription

void setDescription(java.lang.String description)

Sets the description of the group.

Parameters:

description - The description of the group. Mustn't be null.

Throws:

java.lang.IllegalArgumentException - If the name is null.

getLeaders

java.util.List<Experimenter> getLeaders()

Returns the leaders of this group.

Returns:

See above.

getExperimenters

java.util.List<Experimenter> getExperimenters()

Returns the experimenters contained in this group.

Returns:

See above.

getMembersOnly

java.util.List<Experimenter> getMembersOnly()

Returns the list of experimenters that are not owners of the group.

Returns:

See above.

getPermissionsLevel

int getPermissionsLevel()

Returns the permissions level.

Returns:

See above.