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

Type ServiceClass

                            Commandable --+
                                          |
                     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 --+
                                          |
                            ZenPackable --+
                                          |
                                         ServiceClass

Known Subclasses:
IpServiceClass

Base class for all Persistent classes that have relationships. Provides RelationshipManagement, Customized PropertyManagement, Catalog Indexing, and Historical change tracking.
Method Summary
  __init__(self, id, serviceKeys, description)
  addServiceKey(self, key)
Add a key to the service keys.
  count(self)
Return count of instances in this class.
  getServiceClassName(self)
Return the full name of this service class.
  getUrlForUserCommands(self)
Return url for page which manages user commands
  getUserCommandTargets(self)
Called by Commandable.doCommand() to ascertain objects on which a UserCommand should be executed.
  manage_afterAdd(self, item, container)
Device only propagates afterAdd if it is the added object.
  manage_afterClone(self, item)
Not really sure when this is called.
  manage_beforeDelete(self, item, container)
Device only propagates beforeDelete if we are being deleted or copied.
  manage_editServiceClass(self, name, monitor, serviceKeys, port, description, REQUEST)
Edit a ProductClass from a web page.
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, breadCrumbs, 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_removeRelation, manage_workspace, removeRelation, _getCopy, _notifyOfCopyTo, _setObject
Inherited from PrimaryPathObjectManager: _delObject
Inherited from RelCopyContainer: manage_linkObjects, manage_renameObject, manage_unlinkObjects, _getRelName, _getSourceObjects, _verifyObjectLink, _verifyObjectPaste
Inherited from CopyContainer: cb_dataItems, cb_dataValid, manage_clone, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObjects, validClipData, _delOb, _get_id, _getOb, _setOb
Inherited from ObjectManager: __class_init__, __getitem__, _checkId, filtered_meta_types, hasObject, list_imports, 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, _importObjectFromFile, _subobject_permissions
Inherited from Navigation: manage_zmi_logout
Inherited from Tabs: class_manage_path, filtered_manage_options, tabs_path_default, tabs_path_info
Inherited from Acquirer: __new__, __of__
Inherited from Persistent: __getattribute__, bobobase_modification_time, locked_in_version, modified_in_version
Inherited from Persistent: __delattr__, __getstate__, __reduce__, __setattr__, __setstate__, _p_activate, _p_deactivate, _p_delattr, _p_getattr, _p_invalidate, _p_setattr
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, _canCopy, _postCopy, _setId
Inherited from Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_fixupOwnershipAfterAdd, owner_info, userCanTakeOwnership, _deleteOwnershipAfterAdd, manage_changeOwnershipType, manage_takeOwnership
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, _addRole, _delRoles, _has_user_defined_role, _setRoles, manage_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_delLocalRoles, manage_permission, manage_setLocalRoles
Inherited from RoleManager: manage_getPermissionMapping, _isBeingAccessedAsZClassDefinedInstanceMethod, _isBeingUsedAsAMethod, manage_setPermissionMapping
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, _setProperty, _setPropValue
Inherited from PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id, _delProperty, _delPropValue, _propertyMap, _updateProperty, _wrapperCheck
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 Commandable: compile, doCommandForTarget, getAqChainForUserCommands, getUserCommand, getUserCommandEnvironment, getUserCommands, manage_addUserCommand, manage_deleteUserCommand, manage_doUserCommand, manage_editUserCommand, redirectToUserCommands, write
Inherited from Base: __getnewargs__
Inherited from object: __reduce_ex__, __str__
Inherited from SRE_Pattern: _onlystars

Class Variable Summary
tuple __ac_permissions__ = (('Manage DMD', ('manage_editServic...
str default_catalog = 'serviceSearch'
str description = ''
str dmdRootName = 'Services'
tuple factory_type_information = ({'product': 'ZenModel', 'fac...
tuple manage_afterAdd__roles__ = ('Manager',)
tuple manage_afterClone__roles__ = ('Manager',)
tuple manage_beforeDelete__roles__ = ('Manager',)
PermissionRole manage_editServiceClass__roles__ = <PermissionRole objec...
str meta_type = 'ServiceClass'
tuple meta_types = ()
str name = ''
int port = 0                                                                     
tuple serviceKeys = ()
tuple _properties = ({'type': 'string', 'id': 'name', 'mode': ...
tuple _relations = (('pack', <Products.ZenRelations.RelSchema....
Inherited from ZenModelRM: getDmdKey__roles__, isInTree, primarySortKey__roles__, rename__roles__, viewName__roles__, zmanage_editProperties__roles__
Inherited from ZenModelBase: breadCrumbs__roles__, getPrimaryDmdId__roles__, helpLink__roles__, index_html, manage_deleteObjects__roles__, sub_meta_types, view__roles__, zentinelTabs__roles__
Inherited from RelationshipManager: manage_addRelation__roles__, manage_main, manage_main__roles__, manage_options, manage_removeRelation__roles__, manage_workspace__roles__, _operation
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_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__, _objects
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 Persistent: _p_changed, _p_jar, _p_mtime, _p_oid, _p_serial, _p_state
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, _manage_editedDialog
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__, _method_manage_access, _normal_manage_access
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__, _reserved_names
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__, _manage_historyComparePage
Inherited from ZenPacker: security
Inherited from Commandable: defaultTimeout, getUserCommands__roles__, manage_addUserCommand__roles__, manage_deleteUserCommand__roles__, manage_doUserCommand__roles__, manage_editUserCommand__roles__

Instance Method Details

addServiceKey(self, key)

Add a key to the service keys.

count(self)

Return count of instances in this class.

getServiceClassName(self)

Return the full name of this service class.

getUrlForUserCommands(self)

Return url for page which manages user commands
Overrides:
ZenModel.Commandable.Commandable.getUrlForUserCommands (inherited documentation)

getUserCommandTargets(self)

Called by Commandable.doCommand() to ascertain objects on which a UserCommand should be executed.
Overrides:
ZenModel.Commandable.Commandable.getUserCommandTargets

manage_afterAdd(self, item, container)

Device only propagates afterAdd if it is the added object.
Overrides:
OFS.ObjectManager.ObjectManager.manage_afterAdd

manage_afterClone(self, item)

Not really sure when this is called.
Overrides:
OFS.ObjectManager.ObjectManager.manage_afterClone

manage_beforeDelete(self, item, container)

Device only propagates beforeDelete if we are being deleted or copied. Moving and renaming don't propagate.
Overrides:
Products.ZenRelations.RelationshipManager.RelationshipManager.manage_beforeDelete

manage_editServiceClass(self, name='', monitor=False, serviceKeys='', port=0, description='', REQUEST=None)

Edit a ProductClass from a web page.

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('Manage DMD', ('manage_editServiceClass',)),)                        

default_catalog

Type:
str
Value:
'serviceSearch'                                                        

description

Type:
str
Value:
''                                                                     

dmdRootName

Type:
str
Value:
'Services'                                                             

factory_type_information

Type:
tuple
Value:
({'actions': ({'action': 'serviceClassStatus',
               'id': 'status',
               'name': 'Status',
               'permissions': ('View',)},
              {'action': 'serviceClassEdit',
               'id': 'edit',
               'name': 'Edit',
               'permissions': ('Manage DMD',)},
...                                                                    

manage_afterAdd__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_afterClone__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_beforeDelete__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_editServiceClass__roles__

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

meta_type

Type:
str
Value:
'ServiceClass'                                                         

meta_types

Type:
tuple
Value:
()                                                                     

name

Type:
str
Value:
''                                                                     

port

Type:
int
Value:
0                                                                     

serviceKeys

Type:
tuple
Value:
()                                                                     

_properties

Type:
tuple
Value:
({'type': 'string', 'id': 'name', 'mode': 'w'},
 {'type': 'lines', 'id': 'serviceKeys', 'mode': 'w'},
 {'type': 'text', 'id': 'description', 'mode': 'w'})                   

_relations

Type:
tuple
Value:
(('pack', <Products.ZenRelations.RelSchema.ToOne instance at 0x306c468\
>),
 ('instances', <Products.ZenRelations.RelSchema.ToMany instance at 0x3\
2948a0>),
 ('serviceorganizer',
  <Products.ZenRelations.RelSchema.ToOne instance at 0x3294940>),
 ('userCommands',
  <Products.ZenRelations.RelSchema.ToManyCont instance at 0x3294968>)) 

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