applicants.batching - Batch Importer for Applicants

Batch processing for applicants.

class waeup.kofa.applicants.batching.ApplicantOnlinePaymentProcessor

Bases: waeup.kofa.utils.batching.BatchProcessor

The Applicant Online Payment Processor imports applicant payment tickets. The tickets are located in the applicant container.

The checkConversion method checks the format of the payment identifier. In create mode it does also ensures that same p_id does not exist elsewhere. It must be portal-wide unique.

When adding a payment ticket, the addEntry method checks if a payment has already been made. If so, a DuplicationError is raised.

__doc__ = 'The Applicant Online Payment Processor imports applicant payment tickets.\n The tickets are located in the applicant container.\n\n The `checkConversion` method checks the format of the payment identifier.\n In create mode it does also ensures that same p_id does not exist\n elsewhere. It must be portal-wide unique.\n\n When adding a payment ticket, the `addEntry` method checks if a\n payment has already been made. If so, a `DuplicationError` is raised.\n '

__implemented__ = <implementedBy waeup.kofa.applicants.batching.ApplicantOnlinePaymentProcessor>

__module__ = 'waeup.kofa.applicants.batching'

__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)

available_fields

checkConversion(row, mode='ignore')

Validates all values in row.

checkHeaders(headerfields, mode='ignore')

delEntry(row, site)

entryExists(row, site)

factory_name = 'waeup.ApplicantOnlinePayment'

getEntry(row, site)

getMapping(path, headerfields, mode)

Get a mapping from CSV file headerfields to actually used fieldnames.

getParent(row, site)

iface = <InterfaceClass waeup.kofa.applicants.interfaces.IApplicantOnlinePayment>

location_fields = ['applicant_id']

name = u'ApplicantOnlinePayment Processor'

parentsExist(row, site)

samePaymentMade(applicant, category)

updateEntry(obj, row, site, filename)

Update obj to the values given in row.

util_name = 'applicantpaymentprocessor'

class waeup.kofa.applicants.batching.ApplicantProcessor

Bases: waeup.kofa.utils.batching.BatchProcessor

The Applicant Processor imports application data (applicants).

In create mode container_code is required. If application_number is given, an applicant with this number is created in the designated container. If application_number is not given, a random application_number is assigned. applicant_id is being determined by the system and can’t be imported.

In update or remove mode container_code and application_number columns must not exist. The applicant object is solely localized by searching the applicants catalog for reg_number or applicant_id .

__doc__ = "The Applicant Processor imports application data (applicants).\n\n In create mode `container_code` is required. If `application_number` is\n given, an applicant with this number is created in the designated container.\n If `application_number` is not given, a random `application_number` is\n assigned. `applicant_id` is being determined by the system and can't be\n imported.\n\n In update or remove mode `container_code` and `application_number` columns\n must not exist. The applicant object is solely localized by searching\n the applicants catalog for `reg_number` or `applicant_id` .\n "

__implemented__ = <implementedBy waeup.kofa.applicants.batching.ApplicantProcessor>

__module__ = 'waeup.kofa.applicants.batching'

__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)

available_fields

checkConversion(row, mode='create')

Validates all values in row.

checkHeaders(headerfields, mode='create')

checkUpdateRequirements(obj, row, site)

Checks requirements the object must fulfill when being updated.

This method is not used in case of deleting or adding objects.

Returns error messages as strings in case of requirement problems.

delEntry(row, site)

entryExists(row, site)

factory_name = 'waeup.Applicant'

getEntry(row, site)

getLocator(row)

getMapping(path, headerfields, mode)

Get a mapping from CSV file headerfields to actually used fieldnames.

getParent(row, site)

iface = <InterfaceClass waeup.kofa.applicants.interfaces.IApplicant>

iface_byregnumber = <InterfaceClass waeup.kofa.applicants.interfaces.IApplicantUpdateByRegNo>

mode = None

name = u'Applicant Processor'

parentsExist(row, site)

updateEntry(obj, row, site, filename)

Update obj to the values given in row.

util_name = 'applicantprocessor'

class waeup.kofa.applicants.batching.ApplicantsContainerProcessor

Bases: waeup.kofa.utils.batching.BatchProcessor

The Applicants Container Processor imports containers for applicants. It does not import their content. There is nothing special about this processor.

__doc__ = 'The Applicants Container Processor imports containers for applicants.\n It does not import their content. There is nothing special about this\n processor.\n '

__implemented__ = <implementedBy waeup.kofa.applicants.batching.ApplicantsContainerProcessor>

__module__ = 'waeup.kofa.applicants.batching'

__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.ApplicantsContainer'

getEntry(row, site)

getParent(row, site)

iface = <InterfaceClass waeup.kofa.applicants.interfaces.IApplicantsContainer>

location_fields = ['code']

mode = u'create'

name = u'ApplicantsContainer Processor'

parentsExist(row, site)

util_name = 'applicantscontainerprocessor'