Package flumotion :: Package common :: Module messages :: Class Result
[show private | hide private]
[frames | no frames]

Class Result

Jellyable --+        
            |        
 Serializable --+    
                |    
         Copyable --+
                    |
  Unjellyable --+   |
                |   |
       RemoteCopy --+
                    |
                   Result


I am used in worker checks to return a result.
Method Summary
  __init__(self)
  add(self, message)
Add a message to the result.
  succeed(self, value)
Make the result be successful, setting the given result value.
    Inherited from Copyable
  getStateToCopy(self)
Gather state to send when I am serialized for a peer.
  getStateToCopyFor(self, perspective)
Gather state to send when I am serialized for a particular perspective.
  getTypeToCopy(self)
Determine what type tag to send for me.
  getTypeToCopyFor(self, perspective)
Determine what type tag to send for me.
  jellyFor(self, jellier)
Assemble type tag and state to copy for this broker.
    Inherited from Serializable
  processUniqueID(self)
Return an ID which uniquely represents this object for this process.
    Inherited from Jellyable
  getStateFor(self, jellier)
    Inherited from RemoteCopy
  setCopyableState(self, state)
I will be invoked with the state to copy locally.
  unjellyFor(self, unjellier, jellyList)
    Inherited from Unjellyable
  setStateFor(self, unjellier, state)

Instance Variable Summary
  failed: whether or not the check failed.
list of Message messages: list of messages
  value: the result value of the check

Class Variable Summary
    Inherited from Serializable
Implements __implemented__ = <implementedBy twisted.spread.flavors....
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
    Inherited from Jellyable
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...

Method Details

add(self, message)

Add a message to the result.
Parameters:
message
           (type=Message)

succeed(self, value)

Make the result be successful, setting the given result value.

Instance Variable Details

failed

whether or not the check failed. Typically triggered by adding an ERROR message to the result.

messages

list of messages
Type:
list of Message

value

the result value of the check

Generated by Epydoc 2.1 on Wed Sep 13 13:38:36 2006 http://epydoc.sf.net