Package Products :: Package ZenEvents :: Module EventClass :: Class EventClass |
[hide private]
[frames] | no frames]

# Class EventClass

source code

                                                                    object --+
                                                                             |
                                        EventClassInst.EventClassPropertyMixin --+
                                                                                 |
                                                            object --+           |
                                                                     |           |
                                    ZenModel.ZenModelBase.ZenModelBase --+       |
                                                                         |       |
                                   ExtensionClass.Base --+               |       |
                                                         |               |       |
                             OFS.CopySupport.CopyContainer --+           |       |
                                                             |           |       |
                  ZenRelations.RelCopySupport.RelCopyContainer --+       |       |
                                                                 |       |       |
                                   ExtensionClass.Base --+       |       |       |
                                                         |       |       |       |
                             OFS.CopySupport.CopyContainer --+   |       |       |
                                                             |   |       |       |
                                   ExtensionClass.Base --+   |   |       |       |
                                                         |   |   |       |       |
                                 App.Management.Navigation --+   |       |       |
                                                             |   |       |       |
                                   ExtensionClass.Base --+   |   |       |       |
                                                         |   |   |       |       |
                                       App.Management.Tabs --+   |       |       |
                                                             |   |       |       |
                                      Acquisition.Implicit --+   |       |       |
                                                             |   |       |       |
                                    Persistence.Persistent --+   |       |       |
                                                             |   |       |       |
                               ExtensionClass.Base --+       |   |       |       |
                                                     |       |   |       |       |
                webdav.EtagSupport.EtagSupport --+   |       |   |       |       |
                                                 |   |       |   |       |       |
                      webdav.Lockable.LockableItem --+       |   |       |       |
                                                     |       |   |       |       |
                              webdav.Resource.Resource --+   |   |       |       |
                                                         |   |   |       |       |
                              webdav.Collection.Collection --+   |       |       |
                                                             |   |       |       |
                               OFS.Traversable.Traversable --+   |       |       |
                                                             |   |       |       |
                               OFS.ObjectManager.ObjectManager --+       |       |
                                                                 |       |       |
                                   ExtensionClass.Base --+       |       |       |
                                                         |       |       |       |
                               ExtensionClass.Base --+   |       |       |       |
                                                     |   |       |       |       |
                            OFS.CopySupport.CopySource --+       |       |       |
                                                         |       |       |       |
                               ExtensionClass.Base --+   |       |       |       |
                                                     |   |       |       |       |
                                   App.Management.Tabs --+       |       |       |
                                                         |       |       |       |
                           OFS.Traversable.Traversable --+       |       |       |
                                                         |       |       |       |
                             AccessControl.Owned.Owned --+       |       |       |
                                                         |       |       |       |
                                  ZenRelations.ZItem.ZItem --+   |       |       |
                                                             |   |       |       |
                                      Acquisition.Implicit --+   |       |       |
                                                             |   |       |       |
                            AccessControl.Role.RoleManager --+   |       |       |
                                                             |   |       |       |
      ZenRelations.PrimaryPathObjectManager.PrimaryPathManager --+       |       |
                                                                 |       |       |
                                       ExtensionClass.Base --+   |       |       |
                                                             |   |       |       |
                                          App.Undo.UndoSupport --+       |       |
                                                                 |       |       |
    ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager --+   |       |
                                                                     |   |       |
                                                        object --+   |   |       |
                                                                 |   |   |       |
                                       ExtensionClass.Base --+   |   |   |       |
                                                             |   |   |   |       |
                                     OFS.ZDOM.Node --+       |   |   |   |       |
                                                     |       |   |   |   |       |
                                      OFS.ZDOM.Element --+   |   |   |   |       |
                                                         |   |   |   |   |       |
                            OFS.ZDOM.ElementWithAttributes --+   |   |   |       |
                                                             |   |   |   |       |
                           OFS.PropertyManager.PropertyManager --+   |   |       |
                                                                 |   |   |       |
                ZenRelations.ZenPropertyManager.ZenPropertyManager --+   |       |
                                                                     |   |       |
                  ZenRelations.RelationshipManager.RelationshipManager --+       |
                                                                         |       |
                                               ExtensionClass.Base --+   |       |
                                                                     |   |       |
                                                OFS.History.Historical --+       |
                                                                         |       |
                                                            object --+   |       |
                                                                     |   |       |
                                          ZenModel.ZenPacker.ZenPacker --+       |
                                                                         |       |
                                            ZenModel.ZenModelRM.ZenModelRM --+   |
                                                                             |   |
                                                                object --+   |   |
                                                                         |   |   |
                                              ZenModel.EventView.EventView --+   |
                                                                             |   |
                                                  ZenModel.Organizer.Organizer --+
                                                                                 |
                                          ZenModel.ManagedEntity.ManagedEntity --+
                                                                                 |
                                                                    object --+   |
                                                                             |   |
                                              ZenModel.ZenPackable.ZenPackable --+
                                                                                 |
                                                                                EventClass

EventClass organizer

Instance Methods | [hide private]
list of EventClass |
getSubEventClasses(self) Return all EventClass objects below this one. | source code
list |
getOrganizerNames(self, addblank=False, checkPerm=False) Returns a list of all organizer names under this organizer. | source code
list of EventClassInst |
find(self, evClassKey) Look for the eventClassKey mapping in an event class, and return them in sequence number oder, lowest-to-highest. | source code
EventClassInst |
lookup(self, evt, device) Given an event, return an event class organizer object | source code
applyExtraction(self, evt) Don't have extraction on event class. | source code
getInstances(self) Return all EventClassInstances from this node down. | source code
nextSequenceNumber(self, key) Get next sequence number for instance. | source code
string
    >>> dmd.Devices.prepId('ab^*cd')
    'ab__cd'
    >>> dmd.Devices.prepId('ab^*cd', subchar='Z')
    'abZZcd'
    >>> dmd.Devices.prepId('/boot')
    'boot'
    >>> dmd.Devices.prepId('/')
    '-'
    >>> dmd.Devices.prepId(' mydev ')
    'mydev'
prepId(self, id, subchar='_') Clean out an id of illegal characters. | source code
createInstance(self, id=None, REQUEST=None) Add an EventClassInst to this EventClass. | source code
removeInstances(self, ids=None, REQUEST=None) Remove Instances from an EventClass. | source code
moveInstances(self, moveTarget, ids=None, REQUEST=None) Move instances from this EventClass to moveTarget. | source code
countInstances(self) count all instances with in an event dict | source code
buildZProperties(self) | source code
testTransformStyle(self) Test our transform by compiling it. | source code
manage_editEventClassTransform(self, transform='', REQUEST=None) Save the transform | source code
getEventSeverities(self) Return a list of tuples of severities [('Warning', 3), ...] | source code
getEventSeverityString(self, severity) Return a list of tuples of severities [('Warning', 3), ...] | source code
reIndex(self) Go through all ips in this tree and reindex them. | source code
createCatalog(self) Create a catalog for EventClassRecord searching | source code
getOverriddenObjects(self, propname, showDevices=False) Get the objects that override a property somewhere below in the tree This method overrides ZenPropertyManager | source code
string |
getIconPath(self) Override the zProperty icon path and return a folder | source code
getPrettyLink(self, noicon=False, shortDesc=False) Gets a link to this object, plus an icon | source code
Inherited from `EventClassInst.EventClassPropertyMixin`: `applyTransform`, `applyValues`, `formatTransform`, `inheritedTransforms`, `sendTransformException` Inherited from `EventClassInst.EventClassPropertyMixin` (private): `_eventClassPath` Inherited from `ZenModel.Organizer.Organizer`: `__init__`, `childIds`, `childMoveTargets`, `children`, `countChildren`, `createOrganizer`, `deviceMoveTargets`, `exportXmlHook`, `getChildMoveTarget`, `getDmdKey`, `getOrganizer`, `getOrganizerName`, `getSubInstanceIds`, `getSubInstances`, `getSubInstancesGen`, `getSubOrganizers`, `manage_addOrganizer`, `manage_deleteOrganizer`, `manage_deleteOrganizers`, `moveOrganizer`, `urlLink` Inherited from `ZenModel.Organizer.Organizer` (private): `_getCatalog` Inherited from `ZenModel.ZenModelRM.ZenModelRM`: `changePythonClass`, `creator`, `editableDeviceList`, `findChild`, `getCreatedTimeString`, `getModificationTimeString`, `getSubObjects`, `getTreeItems`, `getZenRootNode`, `index_object`, `primarySortKey`, `reindex_all`, `rename`, `setTitle`, `unindex_object`, `viewName`, `zmanage_addProperty`, `zmanage_delObjects`, `zmanage_delProperties`, `zmanage_editProperties`, `zmanage_exportObject`, `zmanage_importObject`, `zmanage_importObjects` Inherited from `ZenModel.ZenModelBase.ZenModelBase`: `__call__`, `__hash__`, `all_meta_types`, `aqBaseHasAttr`, `breadCrumbs`, `callZenScreen`, `checkRemotePerm`, `checkValidId`, `createHierarchyObj`, `custPropertyIds`, `custPropertyMap`, `getBreadCrumbName`, `getBreadCrumbUrlPath`, `getDmd`, `getDmdObj`, `getDmdRoot`, `getHierarchyObj`, `getIdLink`, `getNowString`, `getObjByPath`, `getPrimaryDmdId`, `getUnusedId`, `getZopeObj`, `helpLink`, `isLocalName`, `manage_deleteObjects`, `saveCustProperties`, `todayDate`, `upToOrganizerBreadCrumbs`, `view`, `visibleCustPropertyMap`, `yesterdayDate`, `zenScreenUrl`, `zenpathjoin`, `zenpathsplit`, `zentinelTabs` Inherited from `ZenModel.ZenModelBase.ZenModelBase` (private): `_selectedTabName` Inherited from `ZenRelations.RelationshipManager.RelationshipManager`: `addRelation`, `buildRelations`, `cb_isMoveable`, `checkRelations`, `exportXml`, `exportXmlProperties`, `exportXmlRelationships`, `getRelationshipManagerId`, `getRelationshipNames`, `getRelationships`, `manage_addRelation`, `manage_removeRelation`, `manage_workspace`, `moveMeBetweenRels`, `moveObject`, `removeRelation` Inherited from `ZenRelations.RelationshipManager.RelationshipManager` (private): `_getCopy`, `_notifyOfCopyTo`, `_setObject` Inherited from `ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager` (private): `_delObject` Inherited from `ZenRelations.RelCopySupport.RelCopyContainer`: `manage_linkObjects`, `manage_unlinkObjects` Inherited from `ZenRelations.RelCopySupport.RelCopyContainer` (private): `_checkId`, `_getRelName`, `_getSourceObjects`, `_verifyObjectLink`, `_verifyObjectPaste` Inherited from `OFS.ObjectManager.ObjectManager`: `__class_init__`, `__contains__`, `__delitem__`, `__getitem__`, `__iter__`, `__len__`, `__nonzero__`, `__setitem__`, `filtered_meta_types`, `get`, `getSiteManager`, `hasObject`, `items`, `keys`, `list_imports`, `manage_FTPlist`, `manage_FTPstat`, `manage_afterAdd`, `manage_afterClone`, `manage_beforeDelete`, `manage_delObjects`, `manage_exportObject`, `manage_hasId`, `manage_importObject`, `objectIds`, `objectIds_d`, `objectItems`, `objectItems_d`, `objectMap`, `objectMap_d`, `objectValues`, `objectValues_d`, `setSiteManager`, `superValues`, `tpValues`, `values` Inherited from `OFS.ObjectManager.ObjectManager` (private): `_delOb`, `_getImportPaths`, `_getOb`, `_importObjectFromFile`, `_setOb`, `_subobject_permissions` Inherited from `OFS.CopySupport.CopyContainer`: `cb_dataItems`, `cb_dataValid`, `manage_CopyContainerAllItems`, `manage_CopyContainerFirstItem`, `manage_clone`, `manage_copyObjects`, `manage_cutObjects`, `manage_pasteObjects`, `manage_renameObject`, `manage_renameObjects`, `validClipData` Inherited from `OFS.CopySupport.CopyContainer` (private): `_get_id` Inherited from `App.Management.Navigation`: `manage_zmi_logout` Inherited from `ZenRelations.PrimaryPathObjectManager.PrimaryPathManager`: `getPrimaryId`, `getPrimaryParent`, `getPrimaryPath`, `getPrimaryUrlPath`, `primaryAq` Inherited from `ZenRelations.ZItem.ZItem`: `__repr__`, `getId`, `manage_editedDialog`, `this`, `titleOrId`, `title_and_id`, `title_or_id`, `tpURL` Inherited from `OFS.CopySupport.CopySource`: `cb_isCopyable`, `cb_userHasCopyOrMovePermission` Inherited from `OFS.CopySupport.CopySource` (private): `_canCopy`, `_postCopy`, `_setId` Inherited from `App.Management.Tabs`: `filtered_manage_options`, `tabs_path_default`, `tabs_path_info` Inherited from `webdav.Collection.Collection`: `DELETE`, `HEAD`, `PUT`, `dav__init`, `listDAVObjects` Inherited from `webdav.Resource.Resource`: `COPY`, `LOCK`, `MKCOL`, `MOVE`, `OPTIONS`, `PROPFIND`, `PROPPATCH`, `TRACE`, `UNLOCK`, `dav__simpleifhandler`, `dav__validate`, `manage_DAVget` Inherited from `webdav.Lockable.LockableItem`: `wl_clearLocks`, `wl_delLock`, `wl_getLock`, `wl_hasLock`, `wl_isLocked`, `wl_lockItems`, `wl_lockTokens`, `wl_lockValues`, `wl_lockmapping`, `wl_setLock` Inherited from `webdav.EtagSupport.EtagSupport`: `http__etag`, `http__parseMatchList`, `http__processMatchHeaders`, `http__refreshEtag` Inherited from `OFS.Traversable.Traversable`: `absolute_url`, `absolute_url_path`, `getPhysicalPath`, `restrictedTraverse`, `unrestrictedTraverse`, `virtual_url_path` Inherited from `App.Undo.UndoSupport`: `manage_undo_transactions`, `undoable_transactions` Inherited from `App.Undo.UndoSupport` (private): `_get_request_var_or_attr` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager`: `deleteZenProperty`, `exportZProperties`, `getProperty`, `getPropertyType`, `getZ`, `hasProperty`, `isLocal`, `manage_editProperties`, `saveZenProperties`, `setZenProperty`, `zenPropIsPassword`, `zenPropertyIds`, `zenPropertyItems`, `zenPropertyMap`, `zenPropertyOptions`, `zenPropertyPath`, `zenPropertyString` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager` (private): `_findParentWithProperty`, `_setPropValue`, `_setProperty`, `_updateProperty` Inherited from `OFS.History.Historical`: `manage_afterHistoryCopy`, `manage_beforeHistoryCopy`, `manage_change_history`, `manage_historicalComparison`, `manage_historyCompare`, `manage_historyCopy` Inherited from `ZenModel.ZenPacker.ZenPacker`: `addToZenPack`, `eligiblePacks`, `findObject` Inherited from `ZenModel.EventView.EventView`: `getEventManager`, `getEventSeveritiesCount`, `getEventSummary`, `getStatus`, `getStatusCssClass`, `getStatusImgSrc`, `getStatusString`, `getUUID`, `getWorstEventSeverity`, `manage_ackEvents`, `manage_deleteEvents`, `manage_undeleteEvents` Inherited from `ZenModel.EventView.EventView` (private): `_getCurrentUserName`, `_redirectToEventConsole` Inherited from `OFS.PropertyManager.PropertyManager`: `manage_addProperty`, `manage_changeProperties`, `manage_changePropertyTypes`, `manage_delProperties`, `propdict`, `propertyDescription`, `propertyIds`, `propertyItems`, `propertyLabel`, `propertyMap`, `propertyValues`, `valid_property_id` Inherited from `OFS.PropertyManager.PropertyManager` (private): `_delPropValue`, `_delProperty`, `_propertyMap`, `_wrapperCheck` Inherited from `OFS.ZDOM.ElementWithAttributes`: `getAttribute`, `getAttributeNode`, `getAttributes` Inherited from `OFS.ZDOM.Element`: `getChildNodes`, `getElementsByTagName`, `getFirstChild`, `getLastChild`, `getNextSibling`, `getNodeName`, `getNodeType`, `getParentNode`, `getPreviousSibling`, `getTagName` Inherited from `OFS.ZDOM.Node`: `getNodeValue`, `getOwnerDocument`, `hasChildNodes`

Class Methods | [hide private]
Inherited from `ZenRelations.RelationshipManager.RelationshipManager`: `lookupSchema`

Class Variables | [hide private]
| isInTree = `True`
| transform = `''`
| meta_type = `"EventClass"`
| event_key = `"EventClass"`
| dmdRootName = `"Events"`
| default_catalog = `"eventClassSearch"`
| _relations = `ZenPackable._relations+(("instances", ToManyCont(`...``
| _properties = `Organizer._properties+ EventClassPropertyMixin._`...``
| factory_type_information = `{'id': 'EventClass', 'meta_type': '`...``
| security = `ClassSecurityInfo()`
| severityConversions = `'Critical', 5, ('Error', 4), ('Warning',`...``
| severities = `dict((b, a) for a, b in severityConversions)`
Inherited from `ZenModel.ZenModelBase.ZenModelBase`: `index_html`, `sub_meta_types` Inherited from `ZenModel.ZenModelBase.ZenModelBase` (private): `_zendoc` Inherited from `ZenRelations.RelationshipManager.RelationshipManager`: `manage_main`, `manage_options` Inherited from `ZenRelations.RelationshipManager.RelationshipManager` (private): `_operation` Inherited from `OFS.ObjectManager.ObjectManager`: `has_order_support`, `isAnObjectManager`, `isPrincipiaFolderish`, `manage_addProduct`, `manage_importExportForm`, `manage_index_main`, `meta_types` Inherited from `OFS.ObjectManager.ObjectManager` (private): `_components`, `_objects` Inherited from `OFS.CopySupport.CopyContainer`: `manage_renameForm` Inherited from `App.Management.Navigation`: `manage`, `manage_copyright`, `manage_form_title`, `manage_menu`, `manage_page_footer`, `manage_page_header`, `manage_top_frame`, `manage_zmi_prefs`, `zope_quick_start` Inherited from `ZenRelations.ZItem.ZItem`: `REQUEST`, `__allow_access_to_unprotected_subobjects__`, `__name__`, `__propsets__`, `getId__roles__`, `icon`, `id`, `isTopLevelPrincipiaApplicationObject`, `title` Inherited from `ZenRelations.ZItem.ZItem` (private): `_manage_editedDialog` Inherited from `App.Management.Tabs`: `manage_tabs`, `manage_workspace__roles__` Inherited from `webdav.Collection.Collection`: `__dav_collection__` Inherited from `webdav.Resource.Resource`: `__dav_resource__`, `__http_methods__` Inherited from `OFS.Traversable.Traversable`: `getPhysicalRoot` Inherited from `App.Undo.UndoSupport`: `manage_UndoForm` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager`: `__pychecker__`, `manage_propertiesForm` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager` (private): `_onlystars` Inherited from `OFS.History.Historical`: `HistoricalRevisions`, `manage_change_history_page` Inherited from `OFS.History.Historical` (private): `_manage_historyComparePage` Inherited from `OFS.PropertyManager.PropertyManager`: `manage_propertyTypeForm`, `propertysheets` Inherited from `OFS.PropertyManager.PropertyManager` (private): `_reserved_names`

Method Details | [hide private]

### getSubEventClasses(self) | source code
Return all EventClass objects below this one. Returns: list of EventClass list of event classes

### getOrganizerNames(self, addblank=False, checkPerm=False) | source code
Returns a list of all organizer names under this organizer. Overridden here so that restricted users can get a list of event classes. Parameters: `addblank` (boolean) - If True, add a blank item in the list. Returns: list The DMD paths of all Organizers below this instance. Overrides: ZenModel.Organizer.Organizer.getOrganizerNames Permission: ZEN_COMMON

### find(self, evClassKey) | source code
Look for the eventClassKey mapping in an event class, and return them in sequence number oder, lowest-to-highest. Parameters: `evClassKey` (string) - event class key Returns: list of EventClassInst list of event class mappings that match evClassKey, sorted

### lookup(self, evt, device) | source code
Given an event, return an event class organizer object Parameters: `evt` (dictionary) - an event `device` (DMD device) - device object Returns: EventClassInst an event class that matches the mapping

### prepId(self, id, subchar='_') | source code
Clean out an id of illegal characters. Parameters: `subchar` - Character to be substituted with illegal characters Returns: string
    >>> dmd.Devices.prepId('ab^*cd')
    'ab__cd'
    >>> dmd.Devices.prepId('ab^*cd', subchar='Z')
    'abZZcd'
    >>> dmd.Devices.prepId('/boot')
    'boot'
    >>> dmd.Devices.prepId('/')
    '-'
    >>> dmd.Devices.prepId(' mydev ')
    'mydev'
Overrides: ZenModel.ZenModelBase.ZenModelBase.prepId (inherited documentation)

### testTransformStyle(self) | source code
Test our transform by compiling it. Overrides: EventClassInst.EventClassPropertyMixin.testTransformStyle

### getOverriddenObjects(self, propname, showDevices=False) | source code
Get the objects that override a property somewhere below in the tree This method overrides ZenPropertyManager Overrides: ZenRelations.ZenPropertyManager.ZenPropertyManager.getOverriddenObjects

### getIconPath(self) | source code
Override the zProperty icon path and return a folder Returns: string Path to icon Overrides: ZenModel.ZenModelBase.ZenModelBase.getIconPath

Class Variable Details | [hide private]

  ### _relations Value:
      ZenPackable._relations+(("instances", ToManyCont(ToOne, "Products.ZenE
      vents.EventClassInst", "eventClass")),)

  ### _properties Value:
      Organizer._properties+ EventClassPropertyMixin._properties+({'id': 'tr
      ansform', 'type': 'text', 'mode': 'w'},)

  ### factory_type_information Value:
      {'id': 'EventClass', 'meta_type': 'EventClass', 'description': """Base
       class for all event classes""", 'icon': 'EventClass.gif', 'product':
      'ZenEvents', 'factory': 'manage_addEventClass', 'immediate_view': 'eve
      ntClassStatus', 'actions':({'id': 'classes', 'name': 'Classes', 'actio
      n': 'eventClassStatus', 'permissions':(Permissions.view,)}, {'id': 'ev
      entList', 'name': 'Mappings', 'action': 'eventMappingList', 'permissio
      ns':(Permissions.view,)}, {'id': 'events', 'name': 'Events', 'action':
       'viewEvents', 'permissions':(Permissions.view,)}, {'id': 'config', 'n
      ...

  ### severityConversions Value:
      'Critical', 5, ('Error', 4), ('Warning', 3), ('Info', 2), ('Debug', 1)
      , ('Clear', 0), ('Original',-1),