ome.system

Class Roles

java.lang.Object

ome.system.Roles

All Implemented Interfaces:

java.io.Serializable

public final class Roles
extends java.lang.Object
implements java.io.Serializable

encapsulates the naming scheme for critical system groups and accounts. These values are also used during install to initialize the database.

Since:

3.0-M3

See Also:

Experimenter, ExperimenterGroup, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Roles() default constructor which assigns hard-coded values to all roles
Roles(long rootUserId, java.lang.String rootUserName, long systemGroupId, java.lang.String systemGroupName, long userGroupId, java.lang.String userGroupName, long guestUserId, java.lang.String guestUserName, long guestGroupId, java.lang.String guestGroupName) constructor which allows full specification of all roles

Method Summary

Modifier and Type	Method and Description
long	getGuestGroupId()
java.lang.String	getGuestGroupName()
long	getGuestId()
java.lang.String	getGuestName()
long	getRootId()
java.lang.String	getRootName()
long	getSystemGroupId()
java.lang.String	getSystemGroupName()
long	getUserGroupId()
java.lang.String	getUserGroupName()
boolean	isRootUser(ome.model.meta.Experimenter user)
boolean	isSystemGroup(ome.model.meta.ExperimenterGroup group)
boolean	isUserGroup(ome.model.meta.ExperimenterGroup group)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Roles

public Roles()

default constructor which assigns hard-coded values to all roles

Roles

public Roles(long rootUserId,
             java.lang.String rootUserName,
             long systemGroupId,
             java.lang.String systemGroupName,
             long userGroupId,
             java.lang.String userGroupName,
             long guestUserId,
             java.lang.String guestUserName,
             long guestGroupId,
             java.lang.String guestGroupName)

constructor which allows full specification of all roles

Method Detail

isRootUser

public boolean isRootUser(ome.model.meta.Experimenter user)

isUserGroup

public boolean isUserGroup(ome.model.meta.ExperimenterGroup group)

isSystemGroup

public boolean isSystemGroup(ome.model.meta.ExperimenterGroup group)

getRootId

public long getRootId()

Returns:

the id of the root user

getRootName

public java.lang.String getRootName()

Returns:

the Experimenter.getOmeName() of the root user

getGuestId

public long getGuestId()

Returns:

the id of the guest user

getGuestName

public java.lang.String getGuestName()

Returns:

the Experimenter.getOmeName() of the guest user

getSystemGroupId

public long getSystemGroupId()

Returns:

the id of the system group

getSystemGroupName

public java.lang.String getSystemGroupName()

Returns:

the ExperimenterGroup.getName() of the system group

getUserGroupId

public long getUserGroupId()

Returns:

the id of the user group

getUserGroupName

public java.lang.String getUserGroupName()

Returns:

the ExperimenterGroup.getName() of the user group

getGuestGroupId

public long getGuestGroupId()

Returns:

the id of the guest group

getGuestGroupName

public java.lang.String getGuestGroupName()

Returns:

the ExperimenterGroup.getName() of the guest group