omero.gateway.model

Class ExperimenterData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ExperimenterData

public class ExperimenterData
extends DataObject

The data that makes up an OME Experimenter along with information about the Group the Experimenter belongs in.

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	EMAIL Identifies the ExperimenterI.EMAIL field.
static String	FIRSTNAME Identifies the ExperimenterI.FIRSTNAME field.
static String	GROUP_EXPERIMENTER_MAP Identifies the ExperimenterI.GROUPEXPERIMENTERMAP field.
static String	INSTITUTION Identifies the ExperimenterI.INSTITUTION field.
static String	LASTNAME Identifies the ExperimenterI.LASTNAME field.
static String	MIDDLENAME Identifies the ExperimenterI.MIDDLENAME field.
static String	OMENAME Identifies the ExperimenterI.OMENAME field.

Constructor Summary

Constructors

Constructor and Description
ExperimenterData() Creates a new instance.
ExperimenterData(omero.model.Experimenter experimenter) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
GroupData	getDefaultGroup() Returns the default Group for this Experimenter
String	getEmail() Returns the e-mail of the experimenter.
String	getFirstName() Returns the first name of the experimenter.
long	getGroupId() Overridden to return the id of the default group.
List<GroupData>	getGroups() Returns the groups the experimenter is a member of.
String	getInstitution() Returns the institution where the experimenter works.
String	getLastName() Returns the last name of the experimenter.
String	getMiddleName() Returns the middle name of the experimenter.
String	getUserName() Returns the last name of the experimenter.
boolean	isActive() Returns true if the experimenter is active, false otherwise.
boolean	isLDAP() Returns true if the user is connected via LDAP.
boolean	isMemberOfGroup(long groupId) Checks if supplied group id matches any group to which the current experimenter belongs to.
void	setEmail(String email) Sets the e-mail of the experimenter.
void	setFirstName(String firstName) Sets the first name of the experimenter.
void	setGroups(List<GroupData> newValue) Sets the groups the experimenter is a member of.
void	setInstitution(String institution) Sets the institution where the experimenter works.
void	setLastName(String lastName) Sets the last name of the experimenter.
void	setMiddleName(String middleName) Sets the middle name of the experimenter.

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

FIRSTNAME

public static final String FIRSTNAME

Identifies the ExperimenterI.FIRSTNAME field.

See Also:

Constant Field Values

MIDDLENAME

public static final String MIDDLENAME

Identifies the ExperimenterI.MIDDLENAME field.

See Also:

Constant Field Values

LASTNAME

public static final String LASTNAME

Identifies the ExperimenterI.LASTNAME field.

See Also:

Constant Field Values

EMAIL

public static final String EMAIL

Identifies the ExperimenterI.EMAIL field.

See Also:

Constant Field Values

OMENAME

public static final String OMENAME

Identifies the ExperimenterI.OMENAME field.

See Also:

Constant Field Values

INSTITUTION

public static final String INSTITUTION

Identifies the ExperimenterI.INSTITUTION field.

See Also:

Constant Field Values

GROUP_EXPERIMENTER_MAP

public static final String GROUP_EXPERIMENTER_MAP

Identifies the ExperimenterI.GROUPEXPERIMENTERMAP field.

See Also:

Constant Field Values

Constructor Detail

ExperimenterData

public ExperimenterData()

Creates a new instance.

ExperimenterData

public ExperimenterData(omero.model.Experimenter experimenter)

Creates a new instance.

Parameters:

experimenter - Back pointer to the Experimenter model object. Mustn't be null.

Throws:

IllegalArgumentException - If the object is null.

Method Detail

setFirstName

public void setFirstName(String firstName)

Sets the first name of the experimenter.

Parameters:

firstName - The value to set.

getFirstName

public String getFirstName()

Returns the first name of the experimenter.

Returns:

see above.

setLastName

public void setLastName(String lastName)

Sets the last name of the experimenter.

Parameters:

lastName - The value to set.

getLastName

public String getLastName()

Returns the last name of the experimenter.

Returns:

see above.

getUserName

public String getUserName()

Returns the last name of the experimenter.

Returns:

see above.

setEmail

public void setEmail(String email)

Sets the e-mail of the experimenter.

Parameters:

email - The value to set.

getEmail

public String getEmail()

Returns the e-mail of the experimenter.

Returns:

see above.

setInstitution

public void setInstitution(String institution)

Sets the institution where the experimenter works.

Parameters:

institution - The value to set.

getInstitution

public String getInstitution()

Returns the institution where the experimenter works.

Returns:

see above.

getGroups

public List<GroupData> getGroups()

Returns the groups the experimenter is a member of.

Returns:

See above.

setGroups

public void setGroups(List<GroupData> newValue)

Sets the groups the experimenter is a member of.

Parameters:

newValue - The set of groups.

getDefaultGroup

public GroupData getDefaultGroup()

Returns the default Group for this Experimenter

Returns:

See above.

getMiddleName

public String getMiddleName()

Returns the middle name of the experimenter.

Returns:

see above.

setMiddleName

public void setMiddleName(String middleName)

Sets the middle name of the experimenter.

Parameters:

middleName - The value to set.

isActive

public boolean isActive()

Returns true if the experimenter is active, false otherwise.

Returns:

See above.

getGroupId

public long getGroupId()

Overridden to return the id of the default group.

Overrides:

getGroupId in class DataObject

Returns:

See above.

See Also:

DataObject.getGroupId()

isMemberOfGroup

public boolean isMemberOfGroup(long groupId)

Checks if supplied group id matches any group to which the current experimenter belongs to.

Parameters:

groupId - The id of the group.

Returns:

boolean true/false depending if matching id found

isLDAP

public boolean isLDAP()

Returns true if the user is connected via LDAP.

Returns:

See above.