Products.MightyCal.EventType.DefaultValueProviders (version 1.8)
index
/home/zope/lib/python/Products/MightyCal/EventType/DefaultValueProviders.py

DefaultValueProvider definitions for the MightyCal product.
* Sometimes default values for fields need to be calculated.  This is where DefaultValueProviders
  come into the picture.  For example, When an admin defines a DateTime field, he can choose that the
  default value always be Now, or Today.  Or, in a field that provides a list of possible legit values
  for the field, the default value can always be the first value in that list.  Etc.
* Even though DefaultValueProviders are not intended to be callable directly from the Web, their methods are
  still declared to be private using security.declarePrivate(), to prevent hackers from trying to modify
  backend data by cleverly constructed HTTP requests to objects that aren't accessible from the normal
  user interface.

 
Modules
            
Products.MightyCal.EventType.DataTypes
Products.MightyCal.EventType.DefaultValueProviders
Dumper
zLOG

 
Classes
            
Products.ZCatalog.CatalogAwareness.CatalogAware
AbstractDefaultValueProvider(Products.MightyCal.SItem.SItem, Products.ZCatalog.CatalogAwareness.CatalogAware)
CalendarDefaultValueProvider
EmptyListDefaultValueProvider
LoggedInUserDefaultValueProvider
NowDateTimeDefaultValueProvider
SimpleBooleanDefaultValueProvider
SimpleIntegerDefaultValueProvider
SimpleListDefaultValueProvider
SimpleStringDefaultValueProvider
exceptions.Exception
DefaultValueProviderException
Products.MightyCal.SItem.SItem(OFS.SimpleItem.Item, Acquisition.Acquirer, Acquisition.ExplicitAcquirer, OFS.PropertyManager.PropertyManager, Persistence.Persistent, AccessControl.Role.RoleManager)
AbstractDefaultValueProvider(Products.MightyCal.SItem.SItem, Products.ZCatalog.CatalogAwareness.CatalogAware)
CalendarDefaultValueProvider
EmptyListDefaultValueProvider
LoggedInUserDefaultValueProvider
NowDateTimeDefaultValueProvider
SimpleBooleanDefaultValueProvider
SimpleIntegerDefaultValueProvider
SimpleListDefaultValueProvider
SimpleStringDefaultValueProvider

 
class AbstractDefaultValueProvider
      AbstractDefaultValueProvider is the base class for all MightyCal DefaultValueProvider types
 
  
_destroy(self)
A cleanup routine called whenever a DefaultValueProvider needs to be gotten rid of
_index(self)
Record this object in the ZCatalog, and requests its children to do the same
getDefaultValue(self)
Strings need no conversion
getEditor(self, parentType)
Return HTML snippet that will provide for editing an IntegerDefaultValueProvider
updateInternalSpecification(self, specInfo)
A default implementation that will work for simple DefaultValueProviders

 
class CalendarDefaultValueProvider
      Specifies a default Calendar
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a CalendarDefaultValueProvider
_getFirstCalendar(self)
Always return the first Calendar in the Registry
construct(self)
getDefaultValue(self)
Strings need no conversion

 
class DefaultValueProviderException
      # Indicates that an attempt was made to store a value of an invalid type # in a DefaultValueProvider object
 
  
__init__(self, value)
__str__(self)

 
class EmptyListDefaultValueProvider
      Specifies an empty list as default value
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a EmptyListDefaultValueProvider
construct(self)
updateInternalSpecification(self, specInfo)
There's nothing to update for this default value provider

 
class LoggedInUserDefaultValueProvider
      Specifies the logged in user as the default
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a UserDefaultValueProvider
_getLoggedInUser(self)
Always return the first User in the Registry
construct(self)
getDefaultValue(self)
Strings need no conversion

 
class NowDateTimeDefaultValueProvider
      Specifies current date/time for default value
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a DateTimeDefaultValueProvider
construct(self)
getDefaultValue(self)
Strings need no conversion
updateInternalSpecification(self, specInfo)
There's nothing to update for this default value provider

 
class SimpleBooleanDefaultValueProvider
      Specifies a Boolean for default value
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a BooleanDefaultValueProvider

 
class SimpleIntegerDefaultValueProvider
      Specifies an integer for default value
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a StringDefaultValueProvider
construct(self)

 
class SimpleListDefaultValueProvider
      Specifies a set of values that will be used as defaults
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing an our data provider
construct(self)
updateInternalSpecification(self, specInfo)
Update the list of default values.  Handle the case of the list being empty.

 
class SimpleStringDefaultValueProvider
      Specifies a string for default value
 
  
_getDefaultValueProviderEditor(self)
Return HTML snippet that will provide for editing a StringDefaultValueProvider
construct(self)

 
Functions
            
DefaultValueProviderFactory(valueProvider)
# DefaultValueProvider objects are constructed using this factory, rather than using the usual __init__ # method, so that instances of these objects can be reconstituted from XML descriptions. # Since the __init__ initializer is skipped, the reconstitution routine can create # generic instances, then fill in attribute variables externally.

 
Data
             ACTION_CONTENT_TYPE = 'ActionContentType'

ADD_EVENT_TYPE_METHOD = 'addEventType'

APPROVED_CALENDARS_FIELD = 'ApprovedCalendarField'

BASE_REGEXP_DATA_RANGE_PROVIDER = 'BaseRegexpDataRangeProvider'

BASIC_CONTENT_TYPE = 'BasicContentType'

BOOLEAN_DATA_TYPE = 'BooleanDataType'

BOX_CHECKED = 'on'

CALENDAR_DATA_RANGE_PROVIDER = 'CalendarDataRangeProvider'

CALENDAR_DATA_TYPE = 'CalendarDataType'

CALENDAR_DEFAULT_VALUE_PROVIDER = 'CalendarDefaultValueProvider'

CALENDAR_OBJECT = 'Calendar'

CALENDAR_OWNER = 'calendarOwner'

CALENDAR_REGISTRY = 'CalendarRegistry'

CONTENT_TYPES = 'ContentTypes'

CUSTOMIZABLE_REGEXP_DATA_RANGE_PROVIDER = 'CustomizableRegexpDataRangeProvider'

DATA_RANGE_PROVIDER = 'DataRangeProvider'

DATA_RANGE_PROVIDERS = 'DataRangeProviders'

DATA_TYPES = 'DataTypes'

DATE_TIME_DATA_TYPE = 'DateTimeDataType'

DEFAULT_BOOLEAN_FORMAT = 'T'

DEFAULT_DATE_FORMAT = '%m/%d/%y %I:%M %p'

DEFAULT_INTEGER_FORMAT = '%d'

DEFAULT_STRING_FORMAT = '%s'

DEFAULT_VALUE_PROVIDER = 'DefaultValueProvider'

DEFAULT_VALUE_PROVIDERS = 'DefaultValueProviders'

DESCRIPTION_FIELD = 'DescriptionField'

DESCRIPTION_PROPERTY = 'description'

EMPTY_LIST_DEFAULT_VALUE_PROVIDER = 'EmptyListDefaultValueProvider'

EVENT_DETAIL_TEMPLATE = 'EventDetail'

EVENT_EDITOR_TEMPLATE = 'EventEditor'

EVENT_TIME_FIELD = 'EventTimeField'

FALSE = 0

FIELD_COMMENT = 'fieldComment'

FIELD_TITLE = 'fieldTitle'

IMMUTABLE_FIELD = 'ImmutableField'

INDEXED_FIELD = 'IndexedField'

INTEGER_DATA_TYPE = 'IntegerDataType'

LOGGED_IN_USER_DEFAULT_VALUE_PROVIDER = 'LoggedInUserDefaultValueProvider'

MANDATORY_FIELD = 'MandatoryField'

MEMO_DATA_TYPE = 'MemoDataType'

MULTI_VALUE_DATA_TYPE = 'MultiValueDataType'

NAME = 'name'

NOW_DATE_TIME_DEFAULT_VALUE_PROVIDER = 'NowDateTimeDefaultValueProvider'

NUMERIC_RANGE_DATA_RANGE_PROVIDER = 'NumericRangeDataRangeProvider'

ONE_LINE_DISPLAY_TEMPLATE = 'SingleLineDisplay'

PUBLIC_FIELD = 'PublicField'

RANGE_LIST_CONTENTS = 'rangeListContents'

REQUESTED_CALENDARS_FIELD = 'RequestedCalendarField'

RESOURCE_CONTENT_TYPE = 'ResourceContentType'

SIMPLE_BOOLEAN_DEFAULT_VALUE_PROVIDER = 'SimpleBooleanDefaultValueProvider'

SIMPLE_INTEGER_DEFAULT_VALUE_PROVIDER = 'SimpleIntegerDefaultValueProvider'

SIMPLE_LIST_DATA_RANGE_PROVIDER = 'SimpleListDataRangeProvider'

SIMPLE_LIST_DEFAULT_VALUE_PROVIDER = 'SimpleListDefaultValueProvider'

SIMPLE_STRING_DEFAULT_VALUE_PROVIDER = 'SimpleStringDefaultValueProvider'

SIMPLISTIC_DATA_RANGE_PROVIDER = 'SimplisticDataRangeProvider'

SIMPLISTIC_STRING_DATA_RANGE_PROVIDER = 'SimplisticStringDataRangeProvider'

SPECIFIED_DEFAULT_VALUED = 'specifiedDefaultValue'

STRING_DATA_TYPE = 'StringDataType'

SUBMITTER_FIELD = 'SubmitterField'

TELEPHONE_NUMBER_DATA_RANGE_PROVIDER = 'TelephoneNumberDataRangeProvider'

TITLE_FIELD = 'TitleField'

TITLE_ONLY_DISPLAY_TEMPLATE = 'TitleOnlyDisplay'

TRUE = 1

USER_DATA_RANGE_PROVIDER = 'UserDataRangeProvider'

USER_DATA_TYPE = 'UserDataType'

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

__name__ = 'Products.MightyCal.EventType.DefaultValueProviders'

__version__ = '$Revision: 1.8 $'