Back to index

plone3  3.1.7
_referenceable.py
Go to the documentation of this file.
00001 from zope.interface import Interface
00002 
00003 class IReferenceable(Interface):
00004     """ Referenceable """
00005 
00006     def getRefs(relationship=None):
00007         """get all the referenced objects for this object"""
00008 
00009     def getBRefs(relationship=None):
00010         """get all the back referenced objects for this object"""
00011 
00012     def getReferences(relationship=None):
00013         """ alias for getRefs """
00014 
00015     def getBackReferences(relationship=None):
00016         """ alias for getBRefs """
00017 
00018     def getReferenceImpl(relationship=None):
00019         """ returns the references as objects for this object """
00020 
00021     def getBackReferenceImpl(relationship=None):
00022         """ returns the back references as objects for this object """
00023 
00024     def UID():
00025         """ Unique ID """
00026 
00027     def reference_url():
00028         """like absoluteURL, but return a link to the object with this UID"""
00029 
00030     def hasRelationshipTo(target, relationship=None):
00031         """test is a relationship exists between objects"""
00032 
00033     def addReference(target, relationship=None, **kwargs):
00034         """add a reference to target. kwargs are metadata"""
00035 
00036     def deleteReference(target, relationship=None):
00037         """delete a ref to target"""
00038 
00039     def deleteReferences(relationship=None):
00040         """delete all references from this object"""
00041 
00042     def getRelationships():
00043         """list all the relationship types this object has refs for"""