Package omero :: Package gateway :: Class _ExperimenterWrapper
[hide private]
[frames] | no frames]

Class _ExperimenterWrapper

source code


omero_model_ExperimenterI class wrapper extends BlitzObjectWrapper.

Instance Methods [hide private]
 
__bstrap__(self)
Initialisation method which is implemented by subclasses to set their class variables etc.
source code
 
simpleMarshal(self, xtra=None, parents=False)
Creates a dict representation of this object.
source code
 
_getQueryString(self)
Returns string for building queries, loading Experimenters only.
source code
ConfigParser
getRawPreferences(self)
Returns the experimenter's preferences annotation contents, as a ConfigParser instance
source code
 
setRawPreferences(self, prefs)
Sets the experimenter's preferences annotation contents, passed in as a ConfigParser instance
source code
 
getPreference(self, key, default='', section=None)
Gets a preference for the experimenter
source code
 
getPreferences(self, section=None)
Gets all preferences for section
source code
 
setPreference(self, key, value, section=None)
Sets a preference for the experimenter
source code
DetailsWrapper
getDetails(self)
Make sure we have correct details for this experimenter and return them
source code
String
getName(self)
Returns Experimenter's omeName
source code
String
getDescription(self)
Returns Experimenter's Full Name
source code
String
getFullName(self)
Gets full name of this experimenter.
source code
String
getNameWithInitial(self)
Returns first initial and Last name.
source code
Boolean
isAdmin(self)
Returns true if Experimenter is Admin (if they are in any group named 'system')
source code
Boolean
isActive(self)
Returns true if Experimenter is Active (if they are in any group named 'user')
source code
Boolean
isGuest(self)
Returns true if Experimenter is Guest (if they are in any group named 'guest')
source code

Inherited from BlitzObjectWrapper: __eq__, __getattr__, __init__, __loadedHotSwap__, __prepare__, __repr__, canDelete, canOwnerWrite, canWrite, countChildren, countChildren_cached, creationEventDate, findChildByName, getAncestry, getAnnotation, getChildLinks, getDate, getId, getOwner, getOwnerFullName, getOwnerOmeName, getParent, getParentLinks, isEditable, isLeaded, isOwned, isPrivate, isPublic, isReadOnly, isShared, linkAnnotation, listAnnotations, listChildren, listOrphanedAnnotations, listParents, removeAnnotations, save, saveAs, setDescription, setName, unlinkAnnotations, updateEventDate

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from BlitzObjectWrapper: LINK_PARENT

Class Variables [hide private]

Inherited from BlitzObjectWrapper: CHILD_WRAPPER_CLASS, LINK_CHILD, LINK_CLASS, OMERO_CLASS, PARENT_WRAPPER_CLASS

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__bstrap__(self)

source code 

Initialisation method which is implemented by subclasses to set their class variables etc.

Overrides: BlitzObjectWrapper.__bstrap__
(inherited documentation)

simpleMarshal(self, xtra=None, parents=False)

source code 

Creates a dict representation of this object.
E.g. for Image: {'description': '', 'author': 'Will Moore', 'date': 1286332557.0,
    'type': 'Image', 'id': 3841L, 'name': 'cb_4_w500_t03_z01.tif'}

@param xtra:        A dict of extra keys to include. E.g. 'childCount'
@type xtra:         Dict
@param parents:     If True, include a list of ancestors (in simpleMarshal form) as 'parents'
@type parents:      Boolean
@return:            A dict representation of this object
@rtype:             Dict

Overrides: BlitzObjectWrapper.simpleMarshal
(inherited documentation)

_getQueryString(self)

source code 

Returns string for building queries, loading Experimenters only.

Overrides: BlitzObjectWrapper._getQueryString

getRawPreferences(self)

source code 

Returns the experimenter's preferences annotation contents, as a ConfigParser instance

Returns: ConfigParser
See above

setRawPreferences(self, prefs)

source code 

Sets the experimenter's preferences annotation contents, passed in as a ConfigParser instance

Parameters:
  • prefs (ConfigParser) - ConfigParser of preferences

getPreference(self, key, default='', section=None)

source code 

Gets a preference for the experimenter

Parameters:
  • key - Preference key
  • default - Default value to return
  • section - Preferences section
Returns:
Preference value

getPreferences(self, section=None)

source code 

Gets all preferences for section

Parameters:
  • section - Preferences section
Returns:
Dict of preferences

setPreference(self, key, value, section=None)

source code 

Sets a preference for the experimenter

Parameters:
  • key - Preference key
  • value - Value to set
  • section - Preferences section - created if needed

getDetails(self)

source code 

Make sure we have correct details for this experimenter and return them

Returns: DetailsWrapper
Experimenter Details
Overrides: BlitzObjectWrapper.getDetails

getName(self)

source code 

Returns Experimenter's omeName

Returns: String
Name
Overrides: BlitzObjectWrapper.getName

getDescription(self)

source code 

Returns Experimenter's Full Name

Returns: String
Full Name or None
Overrides: BlitzObjectWrapper.getDescription

getFullName(self)

source code 

Gets full name of this experimenter. E.g. 'William James. Moore' or 'William Moore' if no middle name

Returns: String
Full Name or None

getNameWithInitial(self)

source code 

Returns first initial and Last name. E.g. 'W. Moore'

Returns: String
Initial and last name

isAdmin(self)

source code 

Returns true if Experimenter is Admin (if they are in any group named 'system')

Returns: Boolean
True if experimenter is Admin

isActive(self)

source code 

Returns true if Experimenter is Active (if they are in any group named 'user')

Returns: Boolean
True if experimenter is Active

isGuest(self)

source code 

Returns true if Experimenter is Guest (if they are in any group named 'guest')

Returns: Boolean
True if experimenter is Admin