Class R.R.ReportekEngine(Folder, Toolz, DataflowsManager, CountriesManager):

Part of Reportek.ReportekEngine View In Hierarchy

Stores generic attributes for Reportek

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
74 Method all_meta_types What can you put inside me? Checks if the legal products are
87 Method __init__ constructor
112 Method __setstate__ Undocumented
136 Method manage_editEngine Manage the edited values
148 Method getPartsOfYear Undocumented
155 Method getCoverageLabel Label to be displayed for the geographical coverage field
160 Method getCoverageNoteLabel Label to be displayed for the geographical coverage note field
165 Method getLocationLabel Label for the geographical coverage + geographical coverage note field
170 Method change_ownership Undocumented
189 Method getCountriesList Undocumented
195 Method getCountryByTitle Undocumented
201 Method getReportersByCountry Undocumented
216 Method getWebQURL return '' if there's no WebQuestionnaire attached to this application
220 Method getNotCompletedWorkitems Loops for all the workitems that are in the 'active','inactive','fallout' status
230 Method zipEnvelopes Zip several envelopes together with the metadata
280 Method __getObjects Get objects from catalog identifiers.
294 Method runAutomaticApplications Searches for the active workitems of activities that need triggering
319 Method _xmlrpc_search_delivery Looks for Report Envelopes with the given attributes
332 Method lookup_last_delivery Find the newest delivery with the same location and dataflows,
349 Method harvestXforms calls getXforms from the WebQ, and updates the DataflowMappingRecord table
389 Method getEnvelopesInfo Returns a list with all information about envelopes for a certain obligation,
436 Method manage_editUNSInterface Edit the UNS related properties
451 Method __makeCall makes an XML/RPC authenticated call
456 Method canUserSubscribeToUNS Indicates if the user given as parameter or authenticated
473 Method subscribeToUNS Creates new or updates existing subscription to the specified
514 Method sendNotificationToUNS Sends events data to the specified UNS's push channel
541 Method messageDialog displays a message dialog
548 Method getEnvelopeByURL return the URL of an envelope based on a contained object URL

Inherited from Toolz:

Line # Kind Name Docs
31 Method __valideIssueProperty Check if exists a property with given value
35 Method __validParams Validate sort parameters
48 Method SearchSortWorkitems Returns a sorted list with workitem objects
63 Method getLDAPUser Undocumented
69 Method getLDAPUserFirstName Undocumented
72 Method getLDAPUserLastName Undocumented
75 Method getLDAPUserEmail Undocumented

Inherited from DataflowsManager:

Line # Kind Name Docs
38 Method dataflows_dict Converts the dataflow info into a dictionary
46 Method getDataflowDict returns all properties of a dataflow as dictionary given the uri
55 Method isDataflowTerminated Undocumented
59 Method getDataflowSourceTitle Undocumented
63 Method getDataflowTitle Undocumented
67 Method getDataflowSourceURI Undocumented
71 Method getDataflowDetailsURL Undocumented

Inherited from CountriesManager:

Line # Kind Name Docs
32 Method localities_dict Converts the localities table into a dictionary
42 Method getCountryName Returns country name from the country uri
57 Method getCountryCode Returns country ISO code from the country uri
Line # Kind Name Docs
280 Method __getObjects Get objects from catalog identifiers.
87 Method __init__ constructor
451 Method __makeCall makes an XML/RPC authenticated call
112 Method __setstate__ Undocumented
31 Method __valideIssueProperty Check if exists a property with given value
35 Method __validParams Validate sort parameters
319 Method _xmlrpc_search_delivery Looks for Report Envelopes with the given attributes
74 Method all_meta_types What can you put inside me? Checks if the legal products are
456 Method canUserSubscribeToUNS Indicates if the user given as parameter or authenticated
170 Method change_ownership Undocumented
38 Method dataflows_dict Converts the dataflow info into a dictionary
189 Method getCountriesList Undocumented
195 Method getCountryByTitle Undocumented
57 Method getCountryCode Returns country ISO code from the country uri
42 Method getCountryName Returns country name from the country uri
155 Method getCoverageLabel Label to be displayed for the geographical coverage field
160 Method getCoverageNoteLabel Label to be displayed for the geographical coverage note field
71 Method getDataflowDetailsURL Undocumented
46 Method getDataflowDict returns all properties of a dataflow as dictionary given the uri
59 Method getDataflowSourceTitle Undocumented
67 Method getDataflowSourceURI Undocumented
63 Method getDataflowTitle Undocumented
548 Method getEnvelopeByURL return the URL of an envelope based on a contained object URL
389 Method getEnvelopesInfo Returns a list with all information about envelopes for a certain obligation,
63 Method getLDAPUser Undocumented
75 Method getLDAPUserEmail Undocumented
69 Method getLDAPUserFirstName Undocumented
72 Method getLDAPUserLastName Undocumented
165 Method getLocationLabel Label for the geographical coverage + geographical coverage note field
220 Method getNotCompletedWorkitems Loops for all the workitems that are in the 'active','inactive','fallout' status
148 Method getPartsOfYear Undocumented
201 Method getReportersByCountry Undocumented
216 Method getWebQURL return '' if there's no WebQuestionnaire attached to this application
349 Method harvestXforms calls getXforms from the WebQ, and updates the DataflowMappingRecord table
55 Method isDataflowTerminated Undocumented
32 Method localities_dict Converts the localities table into a dictionary
332 Method lookup_last_delivery Find the newest delivery with the same location and dataflows,
136 Method manage_editEngine Manage the edited values
436 Method manage_editUNSInterface Edit the UNS related properties
541 Method messageDialog displays a message dialog
294 Method runAutomaticApplications Searches for the active workitems of activities that need triggering
48 Method SearchSortWorkitems Returns a sorted list with workitem objects
514 Method sendNotificationToUNS Sends events data to the specified UNS's push channel
473 Method subscribeToUNS Creates new or updates existing subscription to the specified
230 Method zipEnvelopes Zip several envelopes together with the metadata
def all_meta_types(self, interfaces=None):
What can you put inside me? Checks if the legal products are actually installed in Zope
def __init__(self, webq_url=''):
constructor
def __setstate__(self, state):
Undocumented
def manage_editEngine(self, title='', webq_url='', webq_envelope_menu='', webq_before_edit_page='', QA_application='', REQUEST=None):
Manage the edited values
def getPartsOfYear(self):
Undocumented
def getCoverageLabel(self):
Label to be displayed for the geographical coverage field
def getCoverageNoteLabel(self):
Label to be displayed for the geographical coverage note field
def getLocationLabel(self):
Label for the geographical coverage + geographical coverage note field
def change_ownership(self, obj, newuser, deluser):
Undocumented
def getCountriesList(self):
Undocumented
def getCountryByTitle(self, p_title):
Undocumented
def getReportersByCountry(self, p_context, p_role):
Undocumented
def getWebQURL(self):
return '' if there's no WebQuestionnaire attached to this application
def getNotCompletedWorkitems(self, sortby, how):
Loops for all the workitems that are in the 'active','inactive','fallout' status and returns their list
def zipEnvelopes(self, envelopes=, REQUEST=None, RESPONSE=None):
Zip several envelopes together with the metadata
def __getObjects(self, p_brains):
Get objects from catalog identifiers. Skip over the ones that don't really exist.
def runAutomaticApplications(self, p_applications, REQUEST=None): 
Searches for the active workitems of activities that need triggering
on regular basis and calls triggerApplication for them
Example of activity that needs further triggering: AutomaticQA

Note: Since this method is called using a HTTP get, the p_applications
      parameter cannot be a list, but a string. To include more than one
      applications, separate them by ||
def _xmlrpc_search_delivery(self, dataflow_uris, country):
Looks for Report Envelopes with the given attributes
def lookup_last_delivery(self, dataflow_uris, country, reporting_period=''):
Find the newest delivery with the same location and dataflows, but is older than the reporting_period in the argument If the reporting_period is not provided, finds them all until today
def harvestXforms(self):
calls getXforms from the WebQ, and updates the DataflowMappingRecord table for the haswebform attribute To be called on regular basis by a cron job
def getEnvelopesInfo(self, obligation):
Returns a list with all information about envelopes for a certain obligation, including the XML files inside
def manage_editUNSInterface(self, UNS_server, UNS_username, UNS_password, UNS_password_confirmation, UNS_channel_id, UNS_notification_types, REQUEST=None):
Edit the UNS related properties
def __makeCall(self, server, uid, pwd):
makes an XML/RPC authenticated call
def canUserSubscribeToUNS(self, user_id='', REQUEST=None):
Indicates if the user given as parameter or authenticated is allowed to subscribe to UNS for this channel
def subscribeToUNS(self, filter_country='', filter_dataflows=, filter_event_types=, REQUEST=None):
Creates new or updates existing subscription to the specified If there is a request, returns a message, otherwise, returns (1, '') for success (0, error_description) for failure
def sendNotificationToUNS(self, envelope, notification_type, notification_label, actor='system'):
Sends events data to the specified UNS's push channel
def messageDialog(self, message='', action='./manage_main', REQUEST=None):
displays a message dialog
def getEnvelopeByURL(self, file_url, REQUEST=None):
return the URL of an envelope based on a contained object URL
API Documentation for Reportek, generated by pydoctor at 2007-12-19 11:27:55.