Package fr.igred.omero.meta

Class GroupWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<GroupData>

fr.igred.omero.meta.GroupWrapper

public class GroupWrapper
extends GenericObjectWrapper<GroupData>

Class containing a GroupData object.

Wraps function calls to the GroupData contained.

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.

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
GroupWrapper(GroupData group)	Constructor of the class GroupWrapper.

Method Summary

Modifier and Type	Method	Description
GroupData	asGroupData()	Deprecated. Returns the GroupData contained.
java.lang.String	getDescription()	Returns the description of the group.
java.util.List<ExperimenterWrapper>	getExperimenters()	Returns the experimenters contained in this group.
java.util.List<ExperimenterWrapper>	getLeaders()	Returns the leaders of this group.
java.util.List<ExperimenterWrapper>	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 class fr.igred.omero.GenericObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, flatten, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

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

Constructor Detail

GroupWrapper

public GroupWrapper(GroupData group)

Constructor of the class GroupWrapper.

Parameters:

group - The GroupData to wrap in the GroupWrapper.

Method Detail

getName

public java.lang.String getName()

Returns the name of the group.

Returns:

See above.

setName

public 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.

asGroupData

@Deprecated
public GroupData asGroupData()

Deprecated.

Returns the GroupData contained. Use GenericObjectWrapper.asDataObject() instead.

Returns:

See above.

getDescription

public java.lang.String getDescription()

Returns the description of the group.

Returns:

See above.

setDescription

public 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

public java.util.List<ExperimenterWrapper> getLeaders()

Returns the leaders of this group.

Returns:

See above.

getExperimenters

public java.util.List<ExperimenterWrapper> getExperimenters()

Returns the experimenters contained in this group.

Returns:

See above.

getMembersOnly

public java.util.List<ExperimenterWrapper> getMembersOnly()

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

Returns:

See above.

getPermissionsLevel

public int getPermissionsLevel()

Returns the permissions level.

Returns:

See above.