Package ZenRelations :: Module ToOneRelationship :: Class ToOneRelationship
[show private | hide private]
[frames | no frames]

Type ToOneRelationship

    object --+                
             |                
          Base --+            
                 |            
   RoleManager --+            
                 |            
       RoleManager --+        
                     |        
    object --+       |        
             |       |        
          Base --+   |        
                 |   |        
object --+       |   |        
         |       |   |        
      Base --+   |   |        
             |   |   |        
    CopySource --+   |        
                 |   |        
object --+       |   |        
         |       |   |        
      Base --+   |   |        
             |   |   |        
         Owned --+   |        
                 |   |        
object --+       |   |        
         |       |   |        
      Base --+   |   |        
             |   |   |        
          Tabs --+   |        
                 |   |        
   Traversable --+   |        
                 |   |        
             ZItem --+        
                     |        
    object --+       |        
             |       |        
          Base --+   |        
                 |   |        
          Acquirer --+        
                     |        
    PrimaryPathManager --+    
                         |    
          RelationshipBase --+
                             |
                            ToOneRelationship


ToOneRelationship represents a to one Relationship on a RelationshipManager
Method Summary
  __init__(self, id)
  __call__(self)
return the related object when a ToOne relation is called
  checkRelation(self, repair)
Check to make sure that relationship bidirectionality is ok.
  exportXml(self, ofile, ignorerels)
return an xml representation of a ToOneRelationship...
  getPrimaryHref(self)
Return the primary URL for our related object.
  getPrimaryLink(self)
get the link tag of a related object
  getRelatedId(self)
return the id of the our related object
  hasobject(self, obj)
does this relation point to the object passed
  manage_afterAdd(self, item, container)
Don't do anything here because we have on containment
  manage_afterClone(self, item)
Don't do anything here because we have on containment
  manage_beforeDelete(self, item, container)
There are 4 possible states during when beforeDelete is called.
  manage_main(self, REQUEST)
ZMI function to redirect to parent relationship manager
  manage_workspace(self, REQUEST)
ZMI function to return the workspace of the related object
  _add(self, obj)
add a to one side of a relationship if a relationship already exists clear it
  _getCopy(self, container)
Create ToOne copy.
  _remoteRemove(self, obj)
clear the remote side of this relationship
  _remove(self, obj)
remove the to one side of a relationship
Inherited from RelationshipBase: addRelation, cb_isCopyable, cb_isMoveable, getId, getPrimaryParent, getRelationshipManagerClass, remoteClass, remoteName, remoteType, remoteTypeName, removeRelation
Inherited from PrimaryPathManager: getPrimaryId, getPrimaryPath, getPrimaryUrlPath, primaryAq
Inherited from ZItem: __len__, __repr__, manage, manage_editedDialog, manage_FTPlist, manage_FTPstat, objectIds, objectItems, objectValues, raise_standardErrorMessage, this, title_and_id, title_or_id, tpURL, tpValues
Inherited from CopySource: cb_userHasCopyOrMovePermission, _canCopy, _notifyOfCopyTo, _postCopy, _setId
Inherited from Tabs: class_manage_path, filtered_manage_options, tabs_path_default, tabs_path_info
Inherited from Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path
Inherited from Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_fixupOwnershipAfterAdd, owner_info, userCanTakeOwnership, _deleteOwnershipAfterAdd, manage_changeOwnershipType, manage_takeOwnership
Inherited from Acquirer: __new__, __of__
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 Base: __getattribute__, __getnewargs__, __getstate__, __reduce__, __setstate__
Inherited from object: __delattr__, __hash__, __reduce_ex__, __setattr__, __str__

Class Variable Summary
tuple __ac_permissions__ = (('View', ('getPrimaryLink', 'getRe...
PermissionRole getPrimaryLink__roles__ = <PermissionRole object at 0x10...
PermissionRole getRelatedId__roles__ = <PermissionRole object at 0x10bf...
tuple manage_afterAdd__roles__ = ('Manager',)
tuple manage_afterClone__roles__ = ('Manager',)
tuple manage_beforeDelete__roles__ = ('Manager',)
tuple manage_main__roles__ = ('Manager',)
tuple manage_workspace__roles__ = ('Manager',)
str meta_type = 'ToOneRelationship'
Inherited from RelationshipBase: _operation
Inherited from ZItem: __allow_access_to_unprotected_subobjects__, __name__, __propsets__, getId__roles__, icon, id, isPrincipiaFolderish, isTopLevelPrincipiaApplicationObject, manage_options, REQUEST, title, _manage_editedDialog
Inherited from CopySource: __implemented__, __providedBy__, __provides__
Inherited from Tabs: class_manage_path__roles__, filtered_manage_options__roles__, manage_tabs, manage_tabs__roles__
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 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__

Method Details

__call__(self)
(Call operator)

return the related object when a ToOne relation is called
Overrides:
ZenRelations.RelationshipBase.RelationshipBase.__call__

checkRelation(self, repair=False)

Check to make sure that relationship bidirectionality is ok.
Overrides:
ZenRelations.RelationshipBase.RelationshipBase.checkRelation

exportXml(self, ofile, ignorerels=[])

return an xml representation of a ToOneRelationship
<toone id='cricket'>
    /Monitors/Cricket/crk0.srv.hcvlny.cv.net
</toone>

getPrimaryHref(self)

Return the primary URL for our related object.

getPrimaryLink(self)

get the link tag of a related object

getRelatedId(self)

return the id of the our related object

hasobject(self, obj)

does this relation point to the object passed
Overrides:
ZenRelations.RelationshipBase.RelationshipBase.hasobject

manage_afterAdd(self, item, container)

Don't do anything here because we have on containment
Overrides:
ZenRelations.ZItem.ZItem.manage_afterAdd

manage_afterClone(self, item)

Don't do anything here because we have on containment
Overrides:
ZenRelations.ZItem.ZItem.manage_afterClone

manage_beforeDelete(self, item, container)

There are 4 possible states during when beforeDelete is called.
They are defined by the attribute _operation and can be: 
    -1 = object being deleted remove relation
    0 = copy, 1 = move, 2 = rename
Any state less than 1 will provoke deletion of the remote end of the
relationship.
ToOne doesn't call beforeDelete on its related object because its 
not a container.
Overrides:
ZenRelations.ZItem.ZItem.manage_beforeDelete

manage_main(self, REQUEST=None)

ZMI function to redirect to parent relationship manager

manage_workspace(self, REQUEST)

ZMI function to return the workspace of the related object
Overrides:
App.Management.Tabs.manage_workspace

_add(self, obj)

add a to one side of a relationship if a relationship already exists clear it
Overrides:
ZenRelations.RelationshipBase.RelationshipBase._add

_getCopy(self, container)

Create ToOne copy. If this is the one side of one to many we set our side of the relation to point towards the related object (maintain the relationship across the copy).
Overrides:
OFS.CopySupport.CopySource._getCopy

_remoteRemove(self, obj=None)

clear the remote side of this relationship
Overrides:
ZenRelations.RelationshipBase.RelationshipBase._remoteRemove

_remove(self, obj=None)

remove the to one side of a relationship
Overrides:
ZenRelations.RelationshipBase.RelationshipBase._remove

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('View', ('getPrimaryLink', 'getRelatedId')),)                        

getPrimaryLink__roles__

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

getRelatedId__roles__

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

manage_afterAdd__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_afterClone__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_beforeDelete__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_main__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_workspace__roles__

Type:
tuple
Value:
('Manager',)                                                           

meta_type

Type:
str
Value:
'ToOneRelationship'                                                    

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