Back to index

plone3  3.1.7
Public Member Functions
Archetypes.interfaces._base.IBaseFolder Class Reference
Inheritance diagram for Archetypes.interfaces._base.IBaseFolder:
Inheritance graph
[legend]
Collaboration diagram for Archetypes.interfaces._base.IBaseFolder:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def listFolderContents
def folderlistingFolderContents
def getId
def setId
def Type
def getField
def getWrappedField
def getDefault
def isBinary
def isTransformable
def widget
def getContentType
def setContentType
def getPrimaryField
def get_portal_metadata
def Vocabulary
def setDefaults
def update
def edit
def validate_field
def pre_validate
def post_validate
def validate
def SearchableText
def getCharset
def get_size
def processForm
def Schemata
def Schema
def addSubObjects
def getSubObject

Detailed Description

Folderish base interface marker

BaseFolder is subclassing the following classes, too:

Products.CMFDefault.SkinnedFolder.SkinnedFolder
OFS.Folder.Folder

Definition at line 146 of file _base.py.


Member Function Documentation

def Archetypes.interfaces._base.IBaseObject.addSubObjects (   objects,
  REQUEST = None 
) [inherited]
Add a dictionary of objects to the session

Definition at line 126 of file _base.py.

00126 
00127     def addSubObjects(objects, REQUEST=None):
00128         """Add a dictionary of objects to the session
00129         """

def Archetypes.interfaces._base.IBaseObject.edit (   kwargs) [inherited]
Alias for update(**kwargs*)

Definition at line 76 of file _base.py.

00076 
00077     def edit(**kwargs):
00078         """Alias for update(**kwargs*)
00079         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseFolder.folderlistingFolderContents (   contentFilter = None,
  suppressHiddenFiles = 0 
)
Calls listFolderContents in protected only by ACI so that folder_listing
can work without the List folder contents permission, as in CMFDefault

Definition at line 160 of file _base.py.

00160 
00161     def folderlistingFolderContents(contentFilter=None, suppressHiddenFiles=0 ):
00162         """
00163         Calls listFolderContents in protected only by ACI so that folder_listing
00164         can work without the List folder contents permission, as in CMFDefault
00165         """

Returns the portal_metadata for a field

Definition at line 60 of file _base.py.

00060 
00061     def get_portal_metadata(field):
00062         """Returns the portal_metadata for a field
00063         """

Used for FTP and apparently the ZMI now too

Definition at line 109 of file _base.py.

00109 
00110     def get_size():
00111         """Used for FTP and apparently the ZMI now too
00112         """

Here is the caller graph for this function:

Return site default charset, or utf-8

Definition at line 105 of file _base.py.

00105 
00106     def getCharset():
00107         """ Return site default charset, or utf-8
00108         """

Here is the caller graph for this function:

Content type for a field by key

Definition at line 47 of file _base.py.

00047 
00048     def getContentType(key):
00049         """Content type for a field by key
00050         """

Here is the caller graph for this function:

Get default value for a field by id

Definition at line 31 of file _base.py.

00031 
00032     def getDefault(field):
00033         """Get default value for a field by id
00034         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.getField (   key,
  wrapped = False 
) [inherited]
Get a field by id

Definition at line 23 of file _base.py.

00023 
00024     def getField(key, wrapped=False):
00025         """Get a field by id
00026         """

Get the object id

Definition at line 7 of file _base.py.

00007 
00008     def getId():
00009         """Get the object id
00010         """

The primary field is some object that responds to
PUT/manage_FTPget events.

Definition at line 55 of file _base.py.

00055 
00056     def getPrimaryField():
00057         """The primary field is some object that responds to
00058         PUT/manage_FTPget events.
00059         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.getSubObject (   name,
  REQUEST,
  RESPONSE = None 
) [inherited]
Get a dictionary of objects from the session

Definition at line 130 of file _base.py.

00130 
00131     def getSubObject(name, REQUEST, RESPONSE=None):
00132         """Get a dictionary of objects from the session
00133         """

Get a field by id which is explicitly wrapped

Definition at line 27 of file _base.py.

00027 
00028     def getWrappedField(key):
00029         """Get a field by id which is explicitly wrapped
00030         """

Check if an element is binary

Definition at line 35 of file _base.py.

00035 
00036     def isBinary(key):
00037         """Check if an element is binary
00038         """

Returns wether a field is transformable

Definition at line 39 of file _base.py.

00039 
00040     def isTransformable(name):
00041         """Returns wether a field is transformable
00042         """

def Archetypes.interfaces._base.IBaseFolder.listFolderContents (   contentFilter = None,
  suppressHiddenFiles = 0 
)
Folderish base interface marker

BaseFolder is subclassing the following classes, too:

Products.CMFDefault.SkinnedFolder.SkinnedFolder
OFS.Folder.Folder
Optionally you can suppress 'hidden' files, or files that begin with '.'

Definition at line 155 of file _base.py.

00155 
00156     def listFolderContents(contentFilter=None, suppressHiddenFiles=0):
00157         """
00158         Optionally you can suppress 'hidden' files, or files that begin with '.'
00159         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.post_validate (   REQUEST,
  errors 
) [inherited]
Post-validation hook

Definition at line 93 of file _base.py.

00093 
00094     def post_validate(REQUEST, errors):
00095         """Post-validation hook
00096         """

def Archetypes.interfaces._base.IBaseObject.pre_validate (   REQUEST,
  errors 
) [inherited]
Pre-validation hook

Definition at line 89 of file _base.py.

00089 
00090     def pre_validate(REQUEST, errors):
00091         """Pre-validation hook
00092         """

def Archetypes.interfaces._base.IBaseObject.processForm (   data = 1,
  metadata = 0,
  REQUEST = None,
  values = None 
) [inherited]
Process the schema looking for data in the form

Definition at line 113 of file _base.py.

00113 
00114     def processForm(data=1, metadata=0, REQUEST=None, values=None):
00115         """Process the schema looking for data in the form
00116         """

Returns the full schema for the object.  NOTE: This method is
usually added dynamically by ClassGen.

Definition at line 121 of file _base.py.

00121 
00122     def Schema():
00123         """Returns the full schema for the object.  NOTE: This method is
00124         usually added dynamically by ClassGen.
00125         """

Here is the caller graph for this function:

Returns the Schemata for the Object

Definition at line 117 of file _base.py.

00117 
00118     def Schemata():
00119         """Returns the Schemata for the Object
00120         """

Full indexable text

Definition at line 101 of file _base.py.

00101 
00102     def SearchableText():
00103         """Full indexable text
00104         """

Here is the caller graph for this function:

Sets the content type of the primary field

Definition at line 51 of file _base.py.

00051 
00052     def setContentType(value):
00053         """Sets the content type of the primary field
00054         """

Here is the caller graph for this function:

Set default values for the fields

Definition at line 68 of file _base.py.

00068 
00069     def setDefaults():
00070         """Set default values for the fields
00071         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.setId (   value) [inherited]
Set the object id

Definition at line 11 of file _base.py.

00011 
00012     def setId(value):
00013         """Set the object id
00014         """

Here is the caller graph for this function:

Dublin Core element - Object type

this method is redefined in ExtensibleMetadata but we need this
at the object level (i.e. with or without metadata) to interact
with the uid catalog

Definition at line 15 of file _base.py.

00015 
00016     def Type():
00017         """Dublin Core element - Object type
00018 
00019         this method is redefined in ExtensibleMetadata but we need this
00020         at the object level (i.e. with or without metadata) to interact
00021         with the uid catalog
00022         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.update (   kwargs) [inherited]
Update all fields and reindexObject

Definition at line 72 of file _base.py.

00072 
00073     def update(**kwargs):
00074         """Update all fields and reindexObject
00075         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.validate (   REQUEST,
  errors 
) [inherited]
Validate fields

Definition at line 97 of file _base.py.

00097 
00098     def validate(REQUEST, errors):
00099         """Validate fields
00100         """

Here is the caller graph for this function:

def Archetypes.interfaces._base.IBaseObject.validate_field (   name,
  value,
  errors 
) [inherited]
Write a method: validate_foo(new_value) -> "error" or None

If there is a validate method defined for a given field invoke it by name
name -- the name to register errors under
value -- the proposed new value
errors -- dict to record errors in

Definition at line 80 of file _base.py.

00080 
00081     def validate_field(name, value, errors):
00082         """Write a method: validate_foo(new_value) -> "error" or None
00083 
00084         If there is a validate method defined for a given field invoke it by name
00085         name -- the name to register errors under
00086         value -- the proposed new value
00087         errors -- dict to record errors in
00088         """

Vocabulary for a field by key

Definition at line 64 of file _base.py.

00064 
00065     def Vocabulary(key):
00066         """Vocabulary for a field by key
00067         """

def Archetypes.interfaces._base.IBaseObject.widget (   field_name,
  mode = "view",
  field = None,
  kwargs 
) [inherited]
Returns the rendered widget

Definition at line 43 of file _base.py.

00043 
00044     def widget(field_name, mode="view", field=None, **kwargs):
00045         """Returns the rendered widget
00046         """


The documentation for this class was generated from the following file: