Package flumotion :: Package component :: Module feedcomponent :: Class Effect
[show private | hide private]
[frames | no frames]

Class Effect

Loggable --+
           |
          Effect


I am a part of a feed component for a specific group of functionality.
Method Summary
  __init__(self, name)
FeedComponent getComponent(self)
Get the component owning this effect.
  setComponent(self, component)
Set the given component as the effect's owner.
  setUIState(self, state)
Set the given UI state on the effect.
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
dict doLog(self, level, where, format, *args, **kwargs)
Log a message at the given level, with the possibility of going higher up in the stack.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, *args)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.
  warningFailure(self, failure, swallow)
Log a warning about a Failure.

Instance Variable Summary
FeedComponent component: component owning the effect
string name: name of the effect

Class Variable Summary
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from Loggable
Implements __implemented__ = <implementedBy flumotion.common.log.Lo...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...

Method Details

__init__(self, name)
(Constructor)

Parameters:
name - the name of the effect

getComponent(self)

Get the component owning this effect.
Returns:
FeedComponent

setComponent(self, component)

Set the given component as the effect's owner.
Parameters:
component - the component to set as an owner of this effect
           (type=FeedComponent)

setUIState(self, state)

Set the given UI state on the effect. This method is ideal for adding keys to the UI state.
Parameters:
state - the UI state for the component to use.
           (type=flumotion.common.componentui.WorkerComponentUIState)

Instance Variable Details

component

component owning the effect
Type:
FeedComponent

name

name of the effect
Type:
string

Class Variable Details

logCategory

Implementors can provide a category to log their messages under.
Type:
str
Value:
'effect'                                                               

Generated by Epydoc 2.1 on Mon Oct 1 03:52:14 2007 http://epydoc.sf.net