configuration – Portal Configuration Components Module

Components for portal configuration.

class waeup.kofa.configuration.ConfigurationContainer

Bases: grokcore.content.components.Container

The node containing the session configuration models

__doc__ = '\n The node containing the session configuration models\n '

__implemented__ = <implementedBy waeup.kofa.configuration.ConfigurationContainer>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

acronym

Abbreviated Title of University (computed attribute)

addSessionConfiguration(sessionconfiguration)

Add a session configuration object.

captcha

Captcha used for public registration pages (computed attribute)

carry_over

Carry-over Course Registration (computed attribute)

current_academic_session

Current Academic Session (computed attribute)

email_admin

Email Address of Administrator (computed attribute)

email_subject

Subject of Email to Administrator (computed attribute)

export_disabled_message

Export-disabled message (computed attribute)

frontpage

Content in HTML format (computed attribute)

frontpage_dict = {}

maintmode_enabled_by

Maintenance Mode enabled by (computed attribute)

name

Name of University (computed attribute)

name_admin

Name of Administrator (computed attribute)

next_matric_integer

Next Matriculation Number Integer (computed attribute)

next_matric_integer_2

Next Matriculation Number Integer 2 (computed attribute)

next_matric_integer_3

Next Matriculation Number Integer 3 (computed attribute)

next_matric_integer_4

Next Matriculation Number Integer 4 (computed attribute)

smtp_mailer

SMTP mailer to use when sending mail (computed attribute)

class waeup.kofa.configuration.ConfigurationContainerExporter

Bases: grokcore.component.components.GlobalUtility, waeup.kofa.utils.batching.ExporterBase

The Configuration Container Exporter exports all configuration base data. It also exports the last used student id.

__doc__ = 'The Configuration Container Exporter exports all configuration base data.\n It also exports the last used student id.\n '

__implemented__ = <implementedBy waeup.kofa.configuration.ConfigurationContainerExporter>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

export_all(site, filepath=None)

Export base configuration into filepath as CSV data. If filepath is None, a raw string with CSV data is returned.

fields = ('acronym', 'carry_over', 'current_academic_session', 'email_admin', 'email_subject', 'export_disabled_message', 'frontpage', 'maintmode_enabled_by', 'name', 'name_admin', 'next_matric_integer', 'next_matric_integer_2', 'next_matric_integer_3', 'next_matric_integer_4', 'smtp_mailer', 'curr_stud_id')

mangle_value(value, name, context=None)

title = u'Base Configuration'

class waeup.kofa.configuration.ConfigurationContainerFactory

Bases: grokcore.component.components.GlobalUtility

A factory for configuration container. This factory is only needed for import.

__call__(*args, **kw)

__doc__ = 'A factory for configuration container. This factory is only needed\n for import.\n '

__implemented__ = <implementedBy waeup.kofa.configuration.ConfigurationContainerFactory>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

getInterfaces()

class waeup.kofa.configuration.ConfigurationContainerProcessor

Bases: waeup.kofa.utils.batching.BatchProcessor

The Configuration Container Processor processes processes the portal’s base confoiguration data. This container exists in the portal. Thus only the update method is allowed.

__doc__ = "The Configuration Container Processor processes processes the\n portal's base confoiguration data. This container exists in the portal.\n Thus only the update method is allowed.\n\n "

__implemented__ = <implementedBy waeup.kofa.configuration.ConfigurationContainerProcessor>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

available_fields

entryExists(row, site)

factory_name = 'waeup.ConfigurationContainer'

getEntry(row, site)

getParent(row, site)

iface = <InterfaceClass waeup.kofa.interfaces.IConfigurationContainer>

name = u'ConfigurationConainer Processor (update only)'

parentsExist(row, site)

updateEntry(obj, row, site, filename)

Update obj to the values given in row.

util_name = 'configurationcontainerupdater'

class waeup.kofa.configuration.SessionConfiguration

Bases: grokcore.content.components.Model

Session configuration model

__doc__ = '\n Session configuration model\n '

__implemented__ = <implementedBy waeup.kofa.configuration.SessionConfiguration>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

academic_session

Academic Session (computed attribute)

booking_fee

Bed Booking Fee (computed attribute)

clearance_enabled

Clearance enabled (computed attribute)

clearance_fee

Acceptance Fee (computed attribute)

coursereg_deadline

Course Reg. Deadline (computed attribute)

getSessionString()

Return the session string from the vocabulary.

late_registration_fee

Late Course Reg. Fee (computed attribute)

maint_fee

Rent (fallback) (computed attribute)

payment_disabled

Payment disabled (computed attribute)

transcript_fee

Transcript Fee (computed attribute)

transfer_fee

Transfer Fee (computed attribute)

class waeup.kofa.configuration.SessionConfigurationExporter

Bases: grokcore.component.components.GlobalUtility, waeup.kofa.utils.batching.ExporterBase

The Session Configuration Exporter exports all configuration data. It iterates over all objects of the configuration container.

__doc__ = 'The Session Configuration Exporter exports all configuration data.\n It iterates over all objects of the ``configuration`` container.\n '

__implemented__ = <implementedBy waeup.kofa.configuration.SessionConfigurationExporter>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

export(configurations, filepath=None)

Export configurations, an iterable, as CSV file.

If filepath is None, a raw string with CSV data is returned.

export_all(site, filepath=None)

Export session configurations into filepath as CSV data.

If filepath is None, a raw string with CSV data is returned.

fields = ('academic_session', 'booking_fee', 'clearance_enabled', 'clearance_fee', 'coursereg_deadline', 'late_registration_fee', 'maint_fee', 'payment_disabled', 'transcript_fee', 'transfer_fee')

title = u'Session Configurations'

class waeup.kofa.configuration.SessionConfigurationFactory

Bases: grokcore.component.components.GlobalUtility

A factory for session configuration objects.

__call__(*args, **kw)

__doc__ = 'A factory for session configuration objects.\n '

__implemented__ = <implementedBy waeup.kofa.configuration.SessionConfigurationFactory>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

description = u'This factory instantiates new session configurations.'

getInterfaces()

title = (u'Create a new session configuration object.',)

class waeup.kofa.configuration.SessionConfigurationProcessor

Bases: waeup.kofa.utils.batching.BatchProcessor

The (Session) Configuration Processor processes session configuration objects in the configuration container.

__doc__ = 'The (Session) Configuration Processor processes session configuration\n objects in the ``configuration`` container.\n '

__implemented__ = <implementedBy waeup.kofa.configuration.SessionConfigurationProcessor>

__module__ = 'waeup.kofa.configuration'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

addEntry(obj, row, site)

delEntry(row, site)

entryExists(row, site)

factory_name = 'waeup.SessionConfiguration'

getEntry(row, site)

getParent(row, site)

iface = <InterfaceClass waeup.kofa.interfaces.ISessionConfiguration>

name = u'SessionConfiguration Processor'

parentsExist(row, site)

util_name = 'sessionconfigurationprocessor'