Trees       Index       Help   

Chandler

Package osaf :: Package pim :: Module collections :: Class ListCollection
[frames | no frames]

Type ListCollection

object --+                    
         |                    
     CItem --+                
             |                
          Item --+            
                 |            
              Item --+        
                     |        
           ContentItem --+    
                         |    
        AbstractCollection --+
                             |
                            ListCollection

Known Subclasses:
AmazonCollection, FeedChannel

A collection that contains only those items that are explicitly added to it.

Backed by a ref-collection
Method Summary
  __init__(self, *args, **kw)
  __len__(self)
  add(self, item)
Add item to this collection
  clear(self)
Remove all elements in this collection
  contentsUpdated(self, item)
Callback for handling changes found by mapChangesCallable
  empty(self)
Remove all elements in this collection from the repository
  first(self)
Return the first item in the collection
  remove(self, item)
Remove this item from the collection
Inherited from AbstractCollection: __contains__, __iter__, __nonzero__, __str__, collectionChanged, isEmpty, isReadOnly, notifySubscribers, setup
Inherited from ContentItem: __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__, _repr_, addValue, check, clone, 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 AbstractCollection: readOnly
Inherited from ContentItem: bodyString, sharedState

Instance Variable Summary
  about: attribute descriptor
  body: attribute descriptor
  collectionList: attribute descriptor
  collections: attribute descriptor
  color: attribute descriptor
  colorizeIcon: attribute descriptor
  contentsOwner: attribute descriptor
  createdOn: attribute descriptor
  creator: attribute descriptor
  description: attribute descriptor
  displayName: attribute descriptor
  displayNameAlternatives: attribute descriptor
  dontDisplayAsCalendar: attribute descriptor
  iconName: attribute descriptor
  iconNameHasKindVariant: attribute descriptor
  importance: attribute descriptor
  invitees: attribute descriptor
  kindExtent: attribute descriptor
  lastModified: attribute descriptor
  lastModifiedBy: attribute descriptor
  mine: attribute descriptor
  modifiedOn: attribute descriptor
  monitors: attribute descriptor
  outOfTheBoxCollection: attribute descriptor
  previousStamps: attribute descriptor
  private: attribute descriptor
  read: attribute descriptor
  refCollection: Sequence(None)
  references: attribute descriptor
  renameable: attribute descriptor
  rep: attribute descriptor
  sharedIn: attribute descriptor
  shares: attribute descriptor
  subscribers: attribute descriptor
  TPBDetailItemOwner: attribute descriptor
  TPBSelectedItemOwner: attribute descriptor
  trashFor: Sequence(InclusionExclusionCollection)
  viewContainer: attribute descriptor
  watcherDispatch: attribute descriptor
  watchers: attribute descriptor
  watches: attribute descriptor
Inherited from Item: aliasedBy, path, typeFor, version
Inherited from CItem: itsKind, itsName, itsParent, itsPath, itsRoot, itsUUID, itsVersion, itsView

Class Variable Summary
dict __kind_info__ = {'displayName': u'ListCollection'}
Inherited from AbstractCollection: __kind_clouds__
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

add(self, item)

Add item to this collection
Parameters:
item - the item being added to the collection
           (type=Item)

clear(self)

Remove all elements in this collection

contentsUpdated(self, item)

Callback for handling changes found by mapChangesCallable
Overrides:
osaf.pim.collections.AbstractCollection.contentsUpdated (inherited documentation)

empty(self)

Remove all elements in this collection from the repository

first(self)

Return the first item in the collection

remove(self, item)

Remove this item from the collection
Parameters:
item - the item being removed from the collection
           (type=Item)

Instance Variable Details

about

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caae4c>

body

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caac0c>

collectionList

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caad4c>

collections

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caabac>

color

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caa9ec>

colorizeIcon

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaaec>

contentsOwner

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caac2c>

createdOn

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caadec>

creator

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caa9cc>

description

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caac4c>

displayName

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caad8c>

displayNameAlternatives

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaacc>

dontDisplayAsCalendar

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caae6c>

iconName

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caadac>

iconNameHasKindVariant

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caae0c>

importance

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caab8c>

invitees

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caabec>

kindExtent

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caad2c>

lastModified

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caadcc>

lastModifiedBy

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caab6c>

mine

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaa0c>

modifiedOn

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caa9ac>

monitors

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaa8c>

outOfTheBoxCollection

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaccc>

previousStamps

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caab0c>

private

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caae2c>

read

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caac8c>

refCollection

Sequence(None)
Value:
<Role refCollection of <class 'osaf.pim.collections.ListCollection'>>

references

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaa6c>

renameable

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caabcc>

rep

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caab2c>

sharedIn

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caad0c>

shares

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caab4c>

subscribers

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caacec>

TPBDetailItemOwner

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaa4c>

TPBSelectedItemOwner

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caacac>

trashFor

Sequence(InclusionExclusionCollection)
Value:
<Role trashFor of <class 'osaf.pim.collections.ListCollection'>>

viewContainer

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caac6c>

watcherDispatch

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaaac>

watchers

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caad6c>

watches

attribute descriptor
Value:
<chandlerdb.schema.c.CDescriptor object at 0xb7caaa2c>

Class Variable Details

__kind_info__

Type:
dict
Value:
{'displayName': u'ListCollection'}

   Trees       Index       Help   

Chandler

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