Package fr.igred.omero.meta

Class ExperimenterWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<ExperimenterData>

fr.igred.omero.meta.ExperimenterWrapper

public class ExperimenterWrapper
extends GenericObjectWrapper<ExperimenterData>

Class containing an ExperimenterData object.

Wraps function calls to the ExperimenterData contained.

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
ExperimenterWrapper(ExperimenterData experimenter)	Constructor of the class ExperimenterWrapper.

Method Summary

Modifier and Type	Method	Description
ExperimenterData	asExperimenterData()	Deprecated. Returns the ExperimenterData contained.
GroupWrapper	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.
List<GroupWrapper>	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	isAdmin(Client client)	Returns true if the user is a full admin.
boolean	isLDAP()	Returns true if the user is connected via LDAP.
boolean	isLeader(GroupWrapper group)	Returns true if the user owns the specified group.
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	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 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

Constructor Detail

ExperimenterWrapper

public ExperimenterWrapper(ExperimenterData experimenter)

Constructor of the class ExperimenterWrapper.

Parameters:

experimenter - The ExperimenterData to wrap in the ExperimenterWrapper.

Method Detail

asExperimenterData

@Deprecated
public ExperimenterData asExperimenterData()

Deprecated.

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

Returns:

See above.

getFirstName

public String getFirstName()

Returns the first name of the experimenter.

Returns:

see above.

setFirstName

public void setFirstName(String firstName)

Sets the first name of the experimenter.

Parameters:

firstName - The value to set.

getLastName

public String getLastName()

Returns the last 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.

getUserName

public String getUserName()

Returns the last name of the experimenter.

Returns:

see above.

getEmail

public String getEmail()

Returns the e-mail 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.

getInstitution

public String getInstitution()

Returns the institution where the experimenter works.

Returns:

see above.

setInstitution

public void setInstitution(String institution)

Sets the institution where the experimenter works.

Parameters:

institution - The value to set.

getGroups

public List<GroupWrapper> getGroups()

Returns the groups the experimenter is a member of.

Returns:

See above.

getDefaultGroup

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

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 on the matching id found

isLDAP

public boolean isLDAP()

Returns true if the user is connected via LDAP.

Returns:

See above.

isLeader

public boolean isLeader(GroupWrapper group)

Returns true if the user owns the specified group.

Parameters:

group - The group.

Returns:

See above.

isAdmin

public boolean isAdmin(Client client)
                throws ServiceException,
                       AccessException,
                       ExecutionException

Returns true if the user is a full admin.

Parameters:

client - Client that handles the connection

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

ExecutionException - A Facility can't be retrieved or instantiated.