Package Products :: Package ZenModel :: Module MaintenanceWindow :: Class MaintenanceWindow
[show private | hide private]
[frames | no frames]

Type MaintenanceWindow

                     object --+            
                              |            
                           Base --+        
                                  |        
                         Historical --+    
                                      |    
     object --+                       |    
              |                       |    
           Base --+                   |    
                  |                   |    
EtagSupport --+   |                   |    
              |   |                   |    
   LockableItem --+                   |    
                  |                   |    
           Resource --+               |    
                      |               |    
             Collection --+           |    
                          |           |    
         object --+       |           |    
                  |       |           |    
               Base --+   |           |    
                      |   |           |    
          CopyContainer --+           |    
                          |           |    
         object --+       |           |    
                  |       |           |    
               Base --+   |           |    
                      |   |           |    
             Navigation --+           |    
                          |           |    
         object --+       |           |    
                  |       |           |    
               Base --+   |           |    
                      |   |           |    
         object --+   |   |           |    
                  |   |   |           |    
         Persistent --+   |           |    
                      |   |           |    
             Persistent --+           |    
                          |           |    
         object --+       |           |    
                  |       |           |    
               Base --+   |           |    
                      |   |           |    
                   Tabs --+           |    
                          |           |    
            Traversable --+           |    
                          |           |    
         object --+       |           |    
                  |       |           |    
               Base --+   |           |    
                      |   |           |    
               Acquirer --+           |    
                          |           |    
              ObjectManager --+       |    
                              |       |    
         object --+           |       |    
                  |           |       |    
               Base --+       |       |    
                      |       |       |    
        RoleManager --+       |       |    
                      |       |       |    
            RoleManager --+   |       |    
                          |   |       |    
         object --+       |   |       |    
                  |       |   |       |    
               Base --+   |   |       |    
                      |   |   |       |    
     object --+       |   |   |       |    
              |       |   |   |       |    
           Base --+   |   |   |       |    
                  |   |   |   |       |    
         CopySource --+   |   |       |    
                      |   |   |       |    
     object --+       |   |   |       |    
              |       |   |   |       |    
           Base --+   |   |   |       |    
                  |   |   |   |       |    
              Owned --+   |   |       |    
                      |   |   |       |    
     object --+       |   |   |       |    
              |       |   |   |       |    
           Base --+   |   |   |       |    
                  |   |   |   |       |    
               Tabs --+   |   |       |    
                      |   |   |       |    
        Traversable --+   |   |       |    
                      |   |   |       |    
                  ZItem --+   |       |    
                          |   |       |    
         object --+       |   |       |    
                  |       |   |       |    
               Base --+   |   |       |    
                      |   |   |       |    
               Acquirer --+   |       |    
                          |   |       |    
         PrimaryPathManager --+       |    
                              |       |    
         object --+           |       |    
                  |           |       |    
               Base --+       |       |    
                      |       |       |    
          CopyContainer --+   |       |    
                          |   |       |    
           RelCopyContainer --+       |    
                              |       |    
             object --+       |       |    
                      |       |       |    
                   Base --+   |       |    
                          |   |       |    
                UndoSupport --+       |    
                              |       |    
       PrimaryPathObjectManager --+   |    
                                  |   |    
             object --+           |   |    
                      |           |   |    
                   Base --+       |   |    
                          |       |   |    
           Node --+       |       |   |    
                  |       |       |   |    
            Element --+   |       |   |    
                      |   |       |   |    
  ElementWithAttributes --+       |   |    
                          |       |   |    
            PropertyManager --+   |   |    
                              |   |   |    
             ZenPropertyManager --+   |    
                                  |   |    
                RelationshipManager --+    
                                      |    
                         object --+   |    
                                  |   |    
                       ZenModelBase --+    
                                      |    
                         object --+   |    
                                  |   |    
                          ZenPacker --+    
                                      |    
                             ZenModelRM --+
                                          |
                                         MaintenanceWindow

Known Subclasses:
ActionRuleWindow

Base class for all Persistent classes that have relationships. Provides RelationshipManagement, Customized PropertyManagement, Catalog Indexing, and Historical change tracking.
Method Summary
  __init__(self, id)
  begin(self, now)
hook for entering the Maintenance Window: call if you override
  breadCrumbs(self, terminator)
fix up breadCrumbs to add a link back to the Manage tab
  displayName(self)
  end(self)
hook for leaving the Maintenance Window: call if you override
  execute(self, now)
Take the next step: either start or stop the Maintenance Window
  getTargetId(self)
  manage_editMaintenanceWindow(self, startDate, startHours, startMinutes, durationDays, durationHours, durationMinutes, repeat, startProductionState, stopProductionState, enabled, skip, REQUEST, **kw)
Update the maintenance window from GUI elements
  next(self, now)
From Unix time_t now value, return next time_t value for the window to start, or None
  nextEvent(self, now)
Return the time of the next begin() or end()
  niceDuration(self)
Return a human readable version of the duration in days, hours, minutes
  niceStartDate(self)
Return a date in the format use by the calendar javascript
  niceStartDateTime(self)
Return start time as a string with nice sort qualities
  niceStartHour(self)
  niceStartMinute(self)
  niceStartProductionState(self)
Return a string version of the startProductionState
  niceStopProductionState(self)
Return a string version of the stopProductionState
  repeatOptions(self)
Provide the list of REPEAT options
  set(self, start, duration, repeat, enabled)
  setProdState(self, target, state)
  target(self)
Inherited from ZenModelRM: changePythonClass, creator, editableDeviceList, getCreatedTimeString, getDmdKey, getModificationTimeString, getSubObjects, getTreeItems, getZenRootNode, index_object, primarySortKey, reindex_all, rename, unindex_object, viewName, zmanage_addProperty, zmanage_delObjects, zmanage_delProperties, zmanage_editProperties, zmanage_exportObject, zmanage_importObject, zmanage_importObjects
Inherited from ZenModelBase: __call__, __hash__, all_meta_types, callZenScreen, checkValidId, createHierarchyObj, custPropertyIds, custPropertyMap, getDmd, getDmdObj, getDmdRoot, getHierarchyObj, getIdLink, getNowString, getObjByPath, getPrimaryDmdId, getZopeObj, helpLink, isLocalName, manage_deleteObjects, prepId, saveCustProperties, todayDate, view, visibleCustPropertyMap, yesterdayDate, zenpathjoin, zenpathsplit, zenScreenUrl, zentinelTabs
Inherited from RelationshipManager: addRelation, buildRelations, cb_isMoveable, checkRelations, exportXml, exportXmlProperties, exportXmlRelationships, getRelationshipManagerId, getRelationshipNames, getRelationships, lookupSchema, manage_addRelation, manage_beforeDelete, manage_removeRelation, manage_workspace, removeRelation
Inherited from RelCopyContainer: manage_linkObjects, manage_renameObject, manage_unlinkObjects
Inherited from CopyContainer: cb_dataItems, cb_dataValid, manage_clone, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObjects, validClipData
Inherited from ObjectManager: __class_init__, __getitem__, _checkId, filtered_meta_types, hasObject, list_imports, manage_afterAdd, manage_afterClone, manage_delObjects, manage_exportObject, manage_FTPlist, manage_FTPstat, manage_hasId, manage_importObject, objectIds, objectIds_d, objectItems, objectItems_d, objectMap, objectMap_d, objectValues, objectValues_d, superValues, tpValues
Inherited from Navigation: manage_zmi_logout
Inherited from Tabs: class_manage_path, filtered_manage_options, tabs_path_default, tabs_path_info
Inherited from Persistent: __getattribute__, bobobase_modification_time, locked_in_version, modified_in_version
Inherited from Persistent: __delattr__, __getstate__, __reduce__, __setattr__, __setstate__
Inherited from Collection: dav__init, DELETE, HEAD, listDAVObjects, PUT
Inherited from Resource: COPY, dav__simpleifhandler, dav__validate, LOCK, manage_DAVget, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, TRACE, UNLOCK
Inherited from LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockmapping, wl_lockTokens, wl_lockValues, wl_setLock
Inherited from EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag
Inherited from Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path
Inherited from PrimaryPathManager: getPrimaryId, getPrimaryParent, getPrimaryPath, getPrimaryUrlPath, primaryAq
Inherited from ZItem: __len__, __repr__, getId, manage_editedDialog, raise_standardErrorMessage, this, title_and_id, title_or_id, tpURL
Inherited from CopySource: cb_isCopyable, cb_userHasCopyOrMovePermission
Inherited from Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_fixupOwnershipAfterAdd, owner_info, userCanTakeOwnership
Inherited from RoleManager: ac_inherited_permissions, access_debug_info, acquiredRolesAreUsedBy, get_local_roles, get_local_roles_for_userid, get_valid_userids, has_local_roles, manage_access, manage_defined_roles, manage_editRoles, manage_role, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, valid_roles, validate_roles, validRoles
Inherited from RoleManager: manage_getPermissionMapping
Inherited from UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions
Inherited from ZenPropertyManager: deleteZenProperty, isLocal, manage_editProperties, saveZenProperties, setZenProperty, zenPropertyIds, zenPropertyItems, zenPropertyMap, zenPropertyOptions, zenPropertyPath, zenPropertyString, zenPropertyType, zenPropIsPassword
Inherited from PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id
Inherited from ElementWithAttributes: getAttribute, getAttributeNode, getAttributes
Inherited from Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName
Inherited from Node: getNodeValue, getOwnerDocument, hasChildNodes
Inherited from Historical: manage_afterHistoryCopy, manage_beforeHistoryCopy, manage_change_history, manage_historicalComparison, manage_historyCompare, manage_historyCopy
Inherited from ZenPacker: addToZenPack, findObject
Inherited from Base: __getnewargs__
Inherited from object: __reduce_ex__, __str__

Class Variable Summary
tuple __ac_permissions__ = (('Change Maintenance Window', ('ma...
str backCrumb = 'deviceManagement'
PermissionRole breadCrumbs__roles__ = <PermissionRole object at 0x10bf9...
str DAILY = 'Daily'
int duration = 60                                                                    
bool enabled = True
str EVERY_WEEKDAY = 'Every Weekday'
tuple factory_type_information = ({'immediate_view': 'maintena...
str FSOTM = 'First Sunday of the Month'
PermissionRole manage_editMaintenanceWindow__roles__ = <PermissionRole ...
tuple meta_types = ()
str MONTHLY = 'Monthly'
NoneType name = None                                                                  
str NEVER = 'Never'
list REPEAT = ['Never', 'Daily', 'Every Weekday', 'Weekly', '...
str repeat = 'Never'
int skip = 1                                                                     
NoneType start = None                                                                  
NoneType started = None                                                                  
int startProductionState = 300                                                                   
int stopProductionState = -99                                                                   
str WEEKLY = 'Weekly'
Inherited from ZenModelRM: default_catalog, getDmdKey__roles__, isInTree, meta_type, primarySortKey__roles__, rename__roles__, viewName__roles__, zmanage_editProperties__roles__
Inherited from ZenModelBase: getPrimaryDmdId__roles__, helpLink__roles__, index_html, manage_deleteObjects__roles__, sub_meta_types, view__roles__, zentinelTabs__roles__
Inherited from RelationshipManager: manage_addRelation__roles__, manage_beforeDelete__roles__, manage_main, manage_main__roles__, manage_options, manage_removeRelation__roles__, manage_workspace__roles__
Inherited from CopyContainer: __implemented__, __providedBy__, __provides__, manage_clone__roles__, manage_CopyContainerAllItems__roles__, manage_CopyContainerFirstItem__roles__, manage_copyObjects__roles__, manage_cutObjects__roles__, manage_pasteObjects__roles__, manage_renameForm, manage_renameForm__roles__, manage_renameObject__roles__, manage_renameObjects__roles__
Inherited from ObjectManager: __roles__, isAnObjectManager, isPrincipiaFolderish, manage_addProduct, manage_afterAdd__roles__, manage_afterClone__roles__, manage_delObjects__roles__, manage_exportObject__roles__, manage_FTPlist__roles__, manage_FTPstat__roles__, manage_hasId__roles__, manage_importExportForm, manage_importExportForm__roles__, manage_importObject__roles__, manage_index_main, manage_index_main__roles__, objectIds__roles__, objectItems__roles__, objectValues__roles__
Inherited from Navigation: manage, manage__roles__, manage_copyright, manage_copyright__roles__, manage_form_title, manage_form_title__roles__, manage_menu, manage_menu__roles__, manage_page_footer, manage_page_footer__roles__, manage_page_header, manage_page_header__roles__, manage_page_style.css, manage_page_style.css__roles__, manage_top_frame, manage_top_frame__roles__, manage_zmi_logout__roles__, manage_zmi_prefs, manage_zmi_prefs__roles__, zope_quick_start, zope_quick_start__roles__
Inherited from Tabs: class_manage_path__roles__, filtered_manage_options__roles__, manage_tabs, manage_tabs__roles__
Inherited from Collection: __dav_collection__
Inherited from Resource: __dav_resource__, __http_methods__, COPY__roles__, DELETE__roles__, HEAD__roles__, listDAVObjects__roles__, LOCK__roles__, manage_DAVget__roles__, MOVE__roles__, OPTIONS__roles__, PROPFIND__roles__, PROPPATCH__roles__, TRACE__roles__, UNLOCK__roles__
Inherited from LockableItem: wl_clearLocks__roles__, wl_delLock__roles__, wl_getLock__roles__, wl_isLocked__roles__, wl_isLockedByUser__roles__, wl_lockItems__roles__, wl_lockmapping__roles__, wl_lockTokens__roles__, wl_lockValues__roles__, wl_setLock__roles__
Inherited from EtagSupport: __implements__
Inherited from Traversable: absolute_url__roles__, absolute_url_path__roles__, getPhysicalPath__roles__, getPhysicalRoot, getPhysicalRoot__roles__, restrictedTraverse__roles__, unrestrictedTraverse__roles__, virtual_url_path__roles__
Inherited from ZItem: __allow_access_to_unprotected_subobjects__, __name__, __propsets__, getId__roles__, icon, id, isTopLevelPrincipiaApplicationObject, REQUEST, title
Inherited from Owned: changeOwnership__roles__, getOwner__roles__, getOwnerTuple__roles__, getWrappedOwner__roles__, manage_changeOwnershipType__roles__, manage_fixupOwnershipAfterAdd__roles__, manage_owner, manage_owner__roles__, manage_takeOwnership__roles__, owner_info__roles__
Inherited from RoleManager: __ac_local_roles__, __ac_roles__, ac_inherited_permissions__roles__, access_debug_info__roles__, aclAChecked, aclEChecked, aclPChecked, acquiredRolesAreUsedBy__roles__, manage_access__roles__, manage_acquiredForm, manage_acquiredForm__roles__, manage_acquiredPermissions__roles__, manage_addLocalRoles__roles__, manage_changePermissions__roles__, manage_defined_roles__roles__, manage_delLocalRoles__roles__, manage_editLocalRoles, manage_editLocalRoles__roles__, manage_editRoles__roles__, manage_listLocalRoles, manage_listLocalRoles__roles__, manage_permission__roles__, manage_permissionForm, manage_permissionForm__roles__, manage_role__roles__, manage_roleForm, manage_roleForm__roles__, manage_setLocalRoles__roles__, permission_settings__roles__, permissionMappingPossibleValues, permissionsOfRole__roles__, rolesOfPermission__roles__, selectedRoles, smallRolesWidget, userdefined_roles__roles__
Inherited from RoleManager: manage_getPermissionMapping__roles__, manage_setPermissionMapping__roles__
Inherited from UndoSupport: manage_undo_transactions__roles__, manage_UndoForm, manage_UndoForm__roles__, undoable_transactions__roles__
Inherited from ZenPropertyManager: manage_editProperties__roles__, manage_propertiesForm, manage_propertiesForm__roles__
Inherited from PropertyManager: getProperty__roles__, getPropertyType__roles__, hasProperty__roles__, manage_addProperty__roles__, manage_changeProperties__roles__, manage_changePropertyTypes__roles__, manage_delProperties__roles__, manage_propertyTypeForm, manage_propertyTypeForm__roles__, propdict__roles__, propertyIds__roles__, propertyItems__roles__, propertyLabel__roles__, propertyMap__roles__, propertysheets, propertyValues__roles__, valid_property_id__roles__
Inherited from Historical: HistoricalRevisions, manage_afterHistoryCopy__roles__, manage_beforeHistoryCopy__roles__, manage_change_history__roles__, manage_change_history_page, manage_change_history_page__roles__, manage_historicalComparison__roles__, manage_historyCompare__roles__, manage_historyCopy__roles__
Inherited from ZenPacker: security

Instance Method Details

begin(self, now=None)

hook for entering the Maintenance Window: call if you override

breadCrumbs(self, terminator='dmd')

fix up breadCrumbs to add a link back to the Manage tab
Overrides:
Products.ZenModel.ZenModelBase.ZenModelBase.breadCrumbs

end(self)

hook for leaving the Maintenance Window: call if you override

execute(self, now=None)

Take the next step: either start or stop the Maintenance Window

manage_editMaintenanceWindow(self, startDate='', startHours='', startMinutes='00', durationDays='0', durationHours='00', durationMinutes='00', repeat='Never', startProductionState=300, stopProductionState=-99, enabled=True, skip=1, REQUEST=None, **kw)

Update the maintenance window from GUI elements

next(self, now=None)

From Unix time_t now value, return next time_t value for the window to start, or None

nextEvent(self, now)

Return the time of the next begin() or end()

niceDuration(self)

Return a human readable version of the duration in days, hours, minutes

niceStartDate(self)

Return a date in the format use by the calendar javascript

niceStartDateTime(self)

Return start time as a string with nice sort qualities

niceStartProductionState(self)

Return a string version of the startProductionState

niceStopProductionState(self)

Return a string version of the stopProductionState

repeatOptions(self)

Provide the list of REPEAT options

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('Change Maintenance Window', ('manage_editMaintenanceWindow',)),
 ('View', ('breadCrumbs',)))                                           

backCrumb

Type:
str
Value:
'deviceManagement'                                                     

breadCrumbs__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x10bf9f8>                                   

DAILY

Type:
str
Value:
'Daily'                                                                

duration

Type:
int
Value:
60                                                                    

enabled

Type:
bool
Value:
True                                                                   

EVERY_WEEKDAY

Type:
str
Value:
'Every Weekday'                                                        

factory_type_information

Type:
tuple
Value:
({'actions': ({'action': 'maintenanceWindowDetail',
               'id': 'status',
               'name': 'Status',
               'permissions': ('View',)},
              {'action': 'viewHistory',
               'id': 'viewHistory',
               'name': 'Modifications',
               'permissions': ('View',)}),
...                                                                    

FSOTM

Type:
str
Value:
'First Sunday of the Month'                                            

manage_editMaintenanceWindow__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x10bf950>                                   

meta_types

Type:
tuple
Value:
()                                                                     

MONTHLY

Type:
str
Value:
'Monthly'                                                              

name

Type:
NoneType
Value:
None                                                                  

NEVER

Type:
str
Value:
'Never'                                                                

REPEAT

Type:
list
Value:
['Never',
 'Daily',
 'Every Weekday',
 'Weekly',
 'Monthly',
 'First Sunday of the Month']                                          

repeat

Type:
str
Value:
'Never'                                                                

skip

Type:
int
Value:
1                                                                     

start

Type:
NoneType
Value:
None                                                                  

started

Type:
NoneType
Value:
None                                                                  

startProductionState

Type:
int
Value:
300                                                                   

stopProductionState

Type:
int
Value:
-99                                                                   

WEEKLY

Type:
str
Value:
'Weekly'                                                               

Generated by Epydoc 2.1 on Thu Aug 16 09:55:17 2007 http://epydoc.sf.net