Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFQuickInstallerTool.interfaces.portal_quickinstaller.IInstalledProduct Class Reference
Inheritance diagram for CMFQuickInstallerTool.interfaces.portal_quickinstaller.IInstalledProduct:
Inheritance graph
[legend]
Collaboration diagram for CMFQuickInstallerTool.interfaces.portal_quickinstaller.IInstalledProduct:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def update
def log
def hasError
def isLocked
def isHidden
def isInstalled
def getTranscriptAsText
def uninstall
def getInstalledVersion
def getValue

Static Public Attributes

tuple id = Attribute('id', 'Must be set to the same name as the product directory')
tuple types = Attribute('types','default: []')
tuple skins = Attribute('types','default: []')
tuple actions = Attribute('types','default: []')
tuple portalobjects = Attribute('types','default: []')
tuple workflows = Attribute('types','default: []')
tuple leftslots = Attribute('types','default: []')
tuple rightslots = Attribute('types','default: []')

Detailed Description

represents the installed product
    is contained inside the QuickInstallerTool 

Definition at line 68 of file portal_quickinstaller.py.


Constructor & Destructor Documentation

constructor 

Definition at line 82 of file portal_quickinstaller.py.

00082 
00083     def __init__(id):
00084         ''' constructor '''


Member Function Documentation

returns the version of the prod in the moment of installation 

Definition at line 116 of file portal_quickinstaller.py.

00116 
00117     def getInstalledVersion():
00118         ''' returns the version of the prod in the moment of installation '''

return the product's install log as plain text 

Definition at line 104 of file portal_quickinstaller.py.

00104 
00105     def getTranscriptAsText():
00106         ''' return the product's install log as plain text '''

returns a value that is tracked by QuickInstaller 

Definition at line 119 of file portal_quickinstaller.py.

00119 
00120     def getValue(name):
00121         ''' returns a value that is tracked by QuickInstaller '''
returns if the prod is in error state 

Definition at line 92 of file portal_quickinstaller.py.

00092 
00093     def hasError():
00094         ''' returns if the prod is in error state '''

is the product hidden

Definition at line 98 of file portal_quickinstaller.py.

00098 
00099     def isHidden():
00100         ''' is the product hidden'''

determines if the product is in already installed 

Definition at line 101 of file portal_quickinstaller.py.

00101 
00102     def isInstalled():
00103         ''' determines if the product is in already installed '''

is the product locked for uninstall 

Definition at line 95 of file portal_quickinstaller.py.

00095 
00096     def isLocked():
00097         ''' is the product locked for uninstall '''

adds a log to the transcript 

Definition at line 89 of file portal_quickinstaller.py.

00089 
00090     def log(logmsg):
00091         ''' adds a log to the transcript '''

Here is the caller graph for this function:

def CMFQuickInstallerTool.interfaces.portal_quickinstaller.IInstalledProduct.uninstall (   cascade = ['types',
  skins,
  actions,
  portalobjects,
  workflows,
  slots,
  registrypredicates,
  REQUEST = None 
)
uninstalls the prod and removes its deps
   the parameter 'cascade' specifies what should be deleted while
   uninstalling the product

   if the Product has an uninstall() method in its Install.py it gets
   called automatically

Definition at line 108 of file portal_quickinstaller.py.

00108 
00109             'workflows','slots','registrypredicates'],REQUEST=None):
00110         '''uninstalls the prod and removes its deps
00111            the parameter 'cascade' specifies what should be deleted while
00112            uninstalling the product
00113 
00114            if the Product has an uninstall() method in its Install.py it gets
00115            called automatically
        '''
def CMFQuickInstallerTool.interfaces.portal_quickinstaller.IInstalledProduct.update (   settings,
  installedversion = '',
  logmsg = '',
  status = 'installed',
  error = False,
  locked = False,
  hidden = False 
)
updates the product attributes 

Definition at line 86 of file portal_quickinstaller.py.

00086 
00087                error=False, locked=False, hidden=False):
00088         ''' updates the product attributes '''

Here is the caller graph for this function:


Member Data Documentation

Definition at line 76 of file portal_quickinstaller.py.

tuple CMFQuickInstallerTool.interfaces.portal_quickinstaller.IInstalledProduct.id = Attribute('id', 'Must be set to the same name as the product directory') [static]
represents the installed product
is contained inside the QuickInstallerTool 

Definition at line 72 of file portal_quickinstaller.py.

Definition at line 79 of file portal_quickinstaller.py.

Definition at line 77 of file portal_quickinstaller.py.

Definition at line 80 of file portal_quickinstaller.py.

Definition at line 75 of file portal_quickinstaller.py.

Definition at line 74 of file portal_quickinstaller.py.

Definition at line 78 of file portal_quickinstaller.py.


The documentation for this class was generated from the following file: