Trees       Index       Help   

Chandler

Package osaf :: Package sharing :: Module Sharing :: Class Share
[frames | no frames]

Type Share

object --+                
         |                
     CItem --+            
             |            
          Item --+        
                 |        
              Item --+    
                     |    
           ContentItem --+
                         |
                        Share

Known Subclasses:
OneTimeShare
Represents a set of shared items, encapsulating contents, location, access method, data format, sharer and sharees.
Method Summary
  __init__(self, name, parent, kind, view, contents, conduit, format)
  close(self)
  create(self)
  destroy(self)
  exists(self)
  get(self, updateCallback)
  getCount(self)
  getLocation(self, privilege)
  getSharedAttributes(self, item, cloudAlias)
Examine sharing clouds and filterAttributes to determine which attributes to share for a given item
  open(self)
  put(self, updateCallback)
  sync(self, modeOverride, updateCallback)
Inherited from ContentItem: __str__, __unicode__, addToCollection, ExportItemData, getBasedAttributes, getCurrentMeEmailAddress, getEmailAddress, getMembershipItem, getSharedState, InitOutgoingAttributes, isAttributeModifiable, ItemAboutString, ItemBodyString, ItemWhoFromString, ItemWhoString, removeFromCollection, SetItemBodyString, StampKind
Inherited from Item: getDefaultParent, getKind, iterItems
Inherited from Item: __getitem__, __iter__, _repr_, addValue, check, clone, collectionChanged, copy, delete, dir, find, findMatch, findPath, findUUID, getACL, getAttributeValue, getItemChild, getItemCloud, getItemDisplayName, getItemDisplayString, getValue, getVersion, hasAttributeAspect, hasChild, hasChildren, hashItem, hasKey, hasLocalAttributeValue, hasValue, isAttributeDirty, isItemOf, isRemote, iterAttributeValues, iterChildren, mixinKinds, move, placeChild, printItem, refCount, removeACL, removeAttributeValue, removeValue, rename, setACL, setAttributeValue, setPinned, setValue, unwatchCollection, unwatchKind, walk, watchCollection, watchKind
Inherited from CItem: __new__, __repr__, getAttributeAspect, getDirty, isDeleted, isDeleting, isDirty, isNew, isPinned, isSchema, isStale, setDirty
Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__

Property Summary
Inherited from ContentItem: bodyString, sharedState

Instance Variable Summary
  active: One(Boolean)
  conduit: One(ShareConduit)
  contents: One(ContentItem)
  error: One(Text)
  filterAttributes: Sequence(Bytes)
  filterClasses: Sequence(Bytes)
  follows: One(Share)
  format: One(ImportExportFormat)
  hidden: One(Boolean)
  items: Sequence(ContentItem)
  leads: Sequence(Share)
  mode: One(modeEnum)
  sharees: Sequence(Contact)
  sharer: One(Contact)
Inherited from ContentItem: body, contentsOwner, createdOn, creator, importance, lastModified, lastModifiedBy, mine, modifiedOn, previousStamps, private, read, sharedIn, shares, TPBDetailItemOwner, TPBSelectedItemOwner, viewContainer
Inherited from Item: collections, description, displayName, kindExtent, monitors, references, watcherDispatch, watchers, watches
Inherited from Item: aliasedBy, path, typeFor, version
Inherited from CItem: itsKind, itsName, itsParent, itsPath, itsRoot, itsUUID, itsVersion, itsView

Class Variable Summary
dict __kind_clouds__ = {'sharing': <application.schema.Cloud ...
dict __kind_info__ = {'displayName': u'Share Kind', 'descript...
Inherited from ContentItem: READONLY, READWRITE, UNSHARED
Inherited from Item: __default_path__
Inherited from CItem: ADIRTY, CDIRTY, CMERGED, CONTAINER, COPYEXPORT, CORESCHEMA, DELETED, DELETING, DIRTY, FDIRTY, IMPORTING, MERGED, MUTATING, NDIRTY, NEW, NMERGED, NODIRTY, PINNED, RAW, RDIRTY, RMERGED, SAVEMASK, SCHEMA, STALE, VDIRTY, VMERGED, VRDIRTY

Instance Method Details

getSharedAttributes(self, item, cloudAlias='sharing')

Examine sharing clouds and filterAttributes to determine which attributes to share for a given item

Instance Variable Details

active

One(Boolean)

This attribute indicates whether this share should be synced during a 'sync all' operation.
Value:
<Role active of <class 'osaf.sharing.Sharing.Share'>>

conduit

One(ShareConduit)
Value:
<Role conduit of <class 'osaf.sharing.Sharing.Share'>>

contents

One(ContentItem)
Value:
<Role contents of <class 'osaf.sharing.Sharing.Share'>>

error

One(Text)

A message describing the last error; empty string otherwise
Value:
<Role error of <class 'osaf.sharing.Sharing.Share'>>

filterAttributes

Sequence(Bytes)
Value:
<Role filterAttributes of <class 'osaf.sharing.Sharing.Share'>>

filterClasses

Sequence(Bytes)

The list of classes to import/export
Value:
<Role filterClasses of <class 'osaf.sharing.Sharing.Share'>>

follows

One(Share)
Value:
<Role follows of <class 'osaf.sharing.Sharing.Share'>>

format

One(ImportExportFormat)
Value:
<Role format of <class 'osaf.sharing.Sharing.Share'>>

hidden

One(Boolean)

This attribute is used to denote which shares have been created by the user via the detail view (hidden=False) versus those that are being created for other purposes (hidden=True), such as transient import/export shares, .ics publishing, etc.
Value:
<Role hidden of <class 'osaf.sharing.Sharing.Share'>>

items

Sequence(ContentItem)
Value:
<Role items of <class 'osaf.sharing.Sharing.Share'>>

leads

Sequence(Share)
Value:
<Role leads of <class 'osaf.sharing.Sharing.Share'>>

mode

One(modeEnum)

This attribute indicates the sync mode for the share: get, put, or both
Value:
<Role mode of <class 'osaf.sharing.Sharing.Share'>>

sharees

Sequence(Contact)

The people who were invited to this share
Value:
<Role sharees of <class 'osaf.sharing.Sharing.Share'>>

sharer

One(Contact)

The contact who initially published this share
Value:
<Role sharer of <class 'osaf.sharing.Sharing.Share'>>

Class Variable Details

__kind_clouds__

Type:
dict
Value:
{'sharing': <application.schema.Cloud instance at 0xb7671a8c>}

__kind_info__

Type:
dict
Value:
{'displayName': u'Share Kind', 'description': 'Represents a shared col\
lection'}

   Trees       Index       Help   

Chandler

Generated by Epydoc 2.1 on Mon Dec 19 13:33:37 2005 http://epydoc.sf.net