Products.MightyCal.EventType.__init__ (version 1.3)
index
/home/zope/lib/python/Products/MightyCal/EventType/__init__.py

EventType subpackage of the MightyCal package.  Contains the following modules:
* EventType: Allow the admin to define a custom event type, with field types of his choosing.
  Each EventType object contains FieldSpec objects, which define the properties of the fields
  that that particular EventType can carry.
* EventTypeRegistry: Stores the defined EventTypes for the current MightyCal instance.
* EventTypeCollection: Contains EventType objects which are owned by a
  particular Calendar.  The EventTypeCollection is intended to provide a restricted view into
  the overall EventTypeRegistry, so that a CalendarAdmin will see only the EventTypes that
  belong to his Calendar.
* FieldSpec: Defines a particular field type, including the data type it stores, its default
  values, valid range, and various administrative properties.  FieldSpecs implement the Composite
  design pattern, such that their internal structure can take on many different configurations in
  order to support different tasks, while retaining the same public interface for the FieldSpec itself.
* ContentTypes: Define the most basic layer for the content of FieldSpecs... in particular, ContentTypes
  provide the intelligence for managing situations when a single "field" is actually composed
  of several pieces of information.  Currently the following ContentTypes are defined:
  - BasicContentType: useful for holding static data such as strings or dates.
  - ActionContentType: Holds information for defining an action that the MightyCal will take at some
    defined time relative to the event's start or end
  - ResourceContentType: Holds information about a non-shareable resource which needs to be scheduled,
    such as conference rooms, equipment, cars or people.
* DataTypes: Define the fundamental kind of data that a field in an Event can hold, and handles
  updating the actual Zope Properties that hold field values in Events.  Some of these include:
  - StringDataType: Holds strings
  - DateTimeDataType: Holds Zope DateTime objects
  - BooleanDataType: Holds yes/no values, and can convert string values to boolean values
  - IntegerDataType: Holds integer values
  - MultiValueDAtaType: Holds a list of independent values
* DefaultValueProviders: Used by DataTypes to define appropriate default values; these are pluggable, so
  as to give the administrator the ability to switch how default values are discovered.  Among the
  available DefaultValueProviders are:
  - NowDateTimeDefaultValueProvider: Always returns the current date/time
  - SimpleBooleanDefaultValueProvider: Returns true or false, depending on how it's configured
  - SimpleIntegerDefaultValueProvider: Returns the integer that the administrator specifies
  - SimpleStringDefaultValueProvider: Returns the string the administrator specifies
* DataRangeProviders: Similar to validators, except that in addition to performing validation for
  DataTypes, DataRangeProviders also can provide a set of valid values (or a range of valid values).  The
  available DataRangeProviders currently include:
  - CustomizableRegexpDataRangeProvider: Validates the field against a regular expression
  - SimplisticStringDataRangeProvider: Allows any string value to be entered
  - TelephoneNumberDataRangeProvider: Allows only valid phone numbers
  - NumericRangeDataRangeProvider: Allows for defining a valid range for numbers
  - SimpleListDataRangeProvider: Validates against a list of possible values
* Enumerators: Helps with the admin interface for redefining Fieldspecs, by producing an HTML that
  lists all of the choices available for Content types, DataTypes, DefaultValueProviders and
  DataRangeProviders
* Const: Constants definitions for the above modules.

 
Modules
            
Products.MightyCal.EventType.Const
Products.MightyCal.EventType.ContentTypes
Products.MightyCal.EventType.DataRangeProviders
Products.MightyCal.EventType.DataTypes
Products.MightyCal.EventType.DefaultValueProviders
Products.MightyCal.EventType.Enumerators
Products.MightyCal.EventType.EventType
Products.MightyCal.EventType.EventTypeCollection
Products.MightyCal.EventType.EventTypeRegistry
Products.MightyCal.EventType.FieldSpec

 
Data
             __all__ = ['Const', 'EventType', 'EventTypeRegistry', 'FieldSpec', 'Enumerators', 'EventTypeCollection', 'ContentTypes', 'DataTypes', 'DataRangeProviders', 'DefaultValueProviders']

__file__ = '/home/zope/lib/python/Products/MightyCal/EventType/__init__.pyc'

__name__ = 'Products.MightyCal.EventType.__init__'

__version__ = '$Revision: 1.3 $'