Package zope :: Package schema :: Module interfaces :: Class ISet
[show private | hide private]
[frames | no frames]

Type ISet

    Interface --+                
                |                
           IField --+            
                    |            
           IContainer --+        
                        |        
    Interface --+       |        
                |       |        
           IField --+   |        
                    |   |        
            IIterable --+        
                        |        
Interface --+           |        
            |           |        
       IField --+       |        
                |       |        
             ILen --+   |        
                    |   |        
           IMinMaxLen --+        
                        |        
              ICollection --+    
                            |    
         IUnorderedCollection --+
                                |
                               ISet


Class Variable Summary
str bind = "Return a copy of this field which is bound to co...
unicode constraint = u"Check a customized constraint on the valu...
unicode default = u'Default Value\n\nThe field default value may...
unicode description = u'Description\n\nA description of the fiel...
unicode max_length = u'Maximum length\n\n        Value after whi...
unicode min_length = u'Minimum length\n\n        Value after whi...
unicode missing_value = u"Missing Value\n\nIf input for this Fie...
unicode order = u'Field Order\n\n        The order attribute can...
str query = "Query the value of the field for the given obje...
unicode readonly = u"Read Only\n\nIf true, the field's value can...
unicode required = u'Required\n\nTells whether a field requires ...
str set = 'Set the value of the field for the object\n\n    ...
unicode title = u'Title\n\nA short summary or label'
unicode unique = u'This ICollection interface attribute must be ...
unicode validate = u'Validate that the given value is a valid fi...
unicode value_type = u'Value Type\n\nField value items must conf...

Class Variable Details

bind

Type:
str
Value:
"""Return a copy of this field which is bound to context.

        The copy of the Field will have the 'context' attribute set
        to 'object'.  This way a Field can implement more complex
        checks involving the object's location/environment.

        Many fields don't need to be bound. Only fields that condition
        validation or properties on an object containing the field
...                                                                    

constraint

Type:
unicode
Value:
u"Check a customized constraint on the value.\n\n        You can imple\
ment this method with your Field to\n        require a certain constra\
int.  This relaxes the need\n        to inherit/subclass a Field you t\
o add a simple constraint.\n        Returns true if the given value is\
 within the Field's constraint.\n        "                             

default

Type:
unicode
Value:
u'Default Value\n\nThe field default value may be None or a legal\n   \
                     field value'                                      

description

Type:
unicode
Value:
u'Description\n\nA description of the field'                           

max_length

Type:
unicode
Value:
u'Maximum length\n\n        Value after whitespace processing cannot h\
ave greater\n        or equal than max_length characters (if a string \
type) or \n        elements (if another sequence type). If max_length \
is\n        None, there is no maximum.'                                

min_length

Type:
unicode
Value:
u'Minimum length\n\n        Value after whitespace processing cannot h\
ave less than\n        min_length characters (if a string type) or ele\
ments (if\n        another sequence type). If min_length is None, ther\
e is\n        no minimum.\n        '                                   

missing_value

Type:
unicode
Value:
u"Missing Value\n\nIf input for this Field is missing, and that's ok,\\
n                          then this is the value to use"              

order

Type:
unicode
Value:
u'Field Order\n\n        The order attribute can be used to determine \
the order in\n        which fields in a schema were defined. If one fi\
eld is created\n        after another (in the same thread), its order \
will be\n        greater.\n\n        (Fields in separate threads could\
 have the same order.)\n        '                                      

query

Type:
str
Value:
"""Query the value of the field for the given object.

        Return the default if the value hasn't been set.
        """                                                            

readonly

Type:
unicode
Value:
u"Read Only\n\nIf true, the field's value cannot be changed."          

required

Type:
unicode
Value:
u'Required\n\nTells whether a field requires its value to exist.'      

set

Type:
str
Value:
'''Set the value of the field for the object

        Raises a type error if the field is a read-only field.
        '''                                                            

title

Type:
unicode
Value:
u'Title\n\nA short summary or label'                                   

unique

Type:
unicode
Value:
u'This ICollection interface attribute must be True'                   

validate

Type:
unicode
Value:
u'Validate that the given value is a valid field value.\n\n        Ret\
urns nothing but raises an error if the value is invalid.\n        It \
checks everything specific to a Field and also checks\n        with th\
e additional constraint.\n        '                                    

value_type

Type:
unicode
Value:
u'Value Type\n\nField value items must conform to the given type, expr\
essed via a Field.'                                                    

Generated by Epydoc 2.1 on Fri Jun 24 12:01:21 2005 http://epydoc.sf.net