ome.system
Class Roles

java.lang.Object
  extended by ome.system.Roles
All Implemented Interfaces:
Serializable

public final class Roles
extends Object
implements 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
Version:
$Revision: 2146 $, $Date: 2008-02-07 11:21:50 +0000 (Thu, 07 Feb 2008) $
Author:
Josh Moore, josh.moore at gmx.de
See Also:
Experimenter, ExperimenterGroup, Serialized Form

Constructor Summary
Roles()
          default constructor which assigns hard-coded values to all roles
Roles(long rootId, String rootName, long systemGroupId, String systemGroupName, long userGroupId, String userGroupName)
          constructor which allows full specification of all roles
 
Method Summary
 String getGuestGroupName()
           
 long getRootId()
           
 String getRootName()
           
 long getSystemGroupId()
           
 String getSystemGroupName()
           
 long getUserGroupId()
           
 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 rootId,
             String rootName,
             long systemGroupId,
             String systemGroupName,
             long userGroupId,
             String userGroupName)
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 String getRootName()
Returns:
the Experimenter.getOmeName() of the root user

getSystemGroupId

public long getSystemGroupId()
Returns:
the id of the system group

getSystemGroupName

public String getSystemGroupName()
Returns:
the ExperimenterGroup.getName() of the system group

getUserGroupId

public long getUserGroupId()
Returns:
the id of the user group

getUserGroupName

public String getUserGroupName()
Returns:
the ExperimenterGroup.getName() of the user group

getGuestGroupName

public String getGuestGroupName()


OmeroJava Api

Version: Beta-4.2.0-r7571-b29

Copyright © 2009 The University of Dundee. All Rights Reserved.