Class R.E.Envelope(EnvelopeInstance, CountriesManager, EnvelopeRemoteServicesManager, EnvelopeCustomDataflows):

Part of Reportek.Envelope View In Hierarchy

Envelopes are basic container objects that provide a standard interface for object management. Envelope objects also implement a management interface

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
127 Method __init__ Envelope constructor
148 Method __setstate__ Undocumented
152 Method all_meta_types Called by Zope to determine what kind of object the envelope can contain
160 Method PUT_factory If you upload with FTP, it will always create a Document
168 Method bogus_function Undocumented
175 Method PrincipiaSearchSource Just return the description.
182 Method getMySelf Used to retrieve the envelope object from the workitem
186 Method manage_copyDelivery Copies files from another envelope
213 Method index_html Undocumented
236 Method manage_main Define manage main to be context aware
270 Method _check_year_range Swap years if start bigger than end
282 Method years Return the range of years the object pertains to
294 Method getStartDate returns the start date in date format
331 Method release_envelope Releases an envelope to the public
346 Method unrelease_envelope Releases an envelope to the public
361 Method delivery_status Status value of the delivery envelope
397 Method manage_editEnvelope Manage the edited values
421 Method manage_changeEnvelope Manage the changed values
458 Method manage_restrict Restrict access to the named objects.
471 Method manage_unrestrict Remove access restriction to the named objects.
484 Method restrict_editing_files Restrict permission to change files' content.
496 Method unrestrict_editing_files Remove restriction to change files' content.
502 Method _set_restrictions Set access to the named objects.
525 Method areRestrictions Returns 1 if at least a file is restricted from the public, 0 otherwise
537 Method canViewContent Determine whether or not the content of the envelope can be seen by the current user
545 Method canAddFiles Determine whether or not the content of the envelope can be seen by the current user
551 Method canAddFeedback Determine whether or not the current user can add manual feedback
557 Method canEditFeedback Determine whether or not the current user can edit existing manual feedback
563 Method canChangeEnvelope Determine whether or not the current user can change the properties of the envelope
573 Method getFeedbacks return all the feedbacks
578 Method getFeedbackObjects return sorted feedbacks by their 'title' property, the manual feedback if always first
593 Method getManualFeedback return manual feedback
603 Method hasFeedbackForThisRelease Returns true if the envelope contains a Report Feedback
614 Method manage_deleteFeedback Undocumented
643 Method _copy Read binary data from infile and write it to outfile
682 Method envelope_zip Go through the envelope and find all the external documents
732 Method _add_file_from_zip Generate id from filename and make sure,
745 Method manage_addzipfile Expand a zipfile into a number of Documents.
780 Method xml returns the envelope metadata in XML format
798 Method getEnvelopeDocuments Undocumented
807 Method setAcceptTime set accepted status
815 Method bulkAcceptTime Undocumented

Inherited from EnvelopeInstance:

Line # Kind Name Docs
99 Method getWorkflowTabs Returns the tuple:
116 Method getOpenFlowEngine Returns the Collection object, parent of the process
121 Method getActivity Returns the activity of a workitem
129 Method getApplicationUrl Return application definition URL relative to instance and workitem
139 Method getEnvironment Returns the engine, the workitem object, the current process and activity
148 Method getInstanceProcessId Returns the process id from its path
152 Method getProcess Returns the process as an object
160 Method addWorkitem Undocumented
168 Method getJoiningWorkitem Undocumented
179 Method setStatus Undocumented
209 Method is_active_for_me returns >0 if there is an active workitem for that person
222 Method getActiveWorkitems returns all active workitems
227 Method getListOfWorkitems Returns all workitems given a list of statuses
239 Method setPriority Undocumented
243 Method isActiveOrRunning Undocumented
247 Method suspendInstance suspend a specified instance
263 Method resumeInstance resume a specified instance
279 Method terminateInstance terminate a specified instance
294 Method startInstance Starts the flowing of the process instance inside the process definition
310 Method linkWorkitems Undocumented
319 Method assignWorkitem Assign the specified workitem of the specified instance to the specified actor (string)
335 Method unassignWorkitem Unassign the specified workitem
351 Method activateWorkitem declares the activation of the specified workitem of the given instance
374 Method inactivateWorkitem declares the inactivation of the specified workitem of the given instance
389 Method suspendWorkitem declares the suspension of the specified workitem of the given instance
409 Method resumeWorkitem declares the resumption of the specified workitem of the given instance
427 Method completeWorkitem declares the completion of the specified workitem of the given instance
461 Method isEnd Undocumented
467 Method getNextTransitions Returns the list of transition that the given workitem (of the specified instance)
498 Method getDestinations Undocumented
519 Method forwardWorkitem instructs openflow to forward the specified workitem
562 Method getPreviousActor Returns the actor that completed the previous workitem
571 Method changeWorkitem use this API to modify anything of a fallout workitem
613 Method falloutWorkitem drops the workitem in exceptional handling
627 Method sendWorkitemsToException Undocumented
635 Method fallinWorkitem the exceptional specified workitem (of the specified instance) will be put back in the activity
660 Method endFallinWorkitem Ends the exceptional state of the given workitem
673 Method getWorkitemsActiveForMe Returns the list of active workitems
685 Method manageDummyActivity Undocumented
693 Method startAutomaticApplication Undocumented
708 Method callAutoPush Undocumented
724 Method manageWorkitemCreation Undocumented
743 Method startSubflow Undocumented
757 Method getSubflowWorkitem TODO!
767 Method completeSubflow 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

Inherited from EnvelopeRemoteServicesManager:

Line # Kind Name Docs
48 Method hasSpecificFile Checks if an envelope has an XML file with certain schema
54 Method hasFilesForSchema If a values was provided for the p_schema_url, determine whether there are
66 Method canRunQAOnFiles Returns a list of QA script labels
76 Method runQAScript Runs the QA script with the specified id against
110 Method callQAEnvelope Calls the envelope-level statistics, based on a script id which is different for each dataflow.
119 Method runQAScripts Runs multiple QA scripts with the specified file ids
166 Method getDocumentsForRemoteService Finds all Report Documents of type XML that have to begin/complete a remote operation
181 Method triggerApplication Triggers remote applications
194 Method saveXML Saves the XML file modified by the WebQ as Report Document
227 Method fetchFile Grabbs a file from a certain location and uploads it as Report Document
246 Method getXMLFiles Returns a list of the XML files in this envelope.
260 Method getXMLSchemas Gets all the schemas from the contained XML files
270 Method getValidXMLSchemas The purpose is to know if to put an edit button and a record in 'view as...' select
280 Method getWebQ_BeforeEditForm_URL Retrieves the URL to the edit for of the XML file - if any
284 Method getWebQ_MenuEnvelope_URL Retrieves the URL to the edit for of the XML file - if any

Inherited from EnvelopeCustomDataflows:

Line # Kind Name Docs
70 Method getReferencedFiles Returns the Report Document objects which are referenced in an XML file
97 Method getBaseDocumentsCounts returns the count of each type of document
123 Method testAssociatedESRI Undocumented
138 Method getBaseDocuments returns the 'p_type' documents batched and filtered by 'query'
196 Method validParams Validate sort parameters
208 Method valideObjectProperty Check if a string is a valid sortable property
213 Method envelope_zip_draft Go through the envelope and find all the external documents
266 Method getDocumentsByType Undocumented
282 Method generateFileName Undocumented
293 Method getGmlFileAssocFactsheet Undocumented
300 Method generateGmlFileTitle Undocumented
315 Method testExistingFile Undocumented
320 Method createEmptyGmlFile Undocumented
340 Method create_empty_gml_file Undocumented
356 Method uploadESRIFiles Undocumented
370 Method upload_esri_files Undocumented
395 Method uploadGMLFile Undocumented
409 Method upload_gml_file Undocumented
453 Method add_zip_file Undocumented
462 Method getHabitatInfo Undocumented
471 Method getSpeciesInfo Undocumented
481 Method getMapTypes Undocumented
486 Method test_valid_map_name Undocumented
494 Method testValidMapName Undocumented
540 Method processZipNamelist Undocumented
626 Method processZipFile Undocumented
803 Method add_art17_file Undocumented
812 Method zip_to_xml_esri Undocumented
851 Method test_filename_species Undocumented
869 Method process_xml_file Undocumented
911 Method add_xml_file Undocumented
924 Method process_other_file Undocumented
941 Method add_other_file Undocumented
951 Method complete_task Undocumented
962 Method convert_esri_to_xml Undocumented
1038 Method convert_ESRI2XML Undocumented
1063 Method convert_excel_rivers Undocumented
1067 Method _extract_xml_schema Undocumented
1086 Method _get_xml_files_by_schema Undocumented
1091 Method convert_xml_rivers Undocumented
1134 Method convert_data_rivers Undocumented
1153 Method fetchXMLFileGW Grabs one XML file from a fixed location and uploads it as Report Document
1185 Method uploadGISfiles Undocumented
1217 Method uploadGISZIPfiles Undocumented
1284 Method upload_MO_delivery Takes a file as input and converts it using a conversion function
1388 Method convert_delivery2XML Calls a conversion function from the conversion service via XML-RPC
Line # Kind Name Docs
127 Method __init__ Envelope constructor
148 Method __setstate__ Undocumented
732 Method _add_file_from_zip Generate id from filename and make sure,
270 Method _check_year_range Swap years if start bigger than end
643 Method _copy Read binary data from infile and write it to outfile
1067 Method _extract_xml_schema Undocumented
1086 Method _get_xml_files_by_schema Undocumented
502 Method _set_restrictions Set access to the named objects.
351 Method activateWorkitem declares the activation of the specified workitem of the given instance
803 Method add_art17_file Undocumented
941 Method add_other_file Undocumented
911 Method add_xml_file Undocumented
453 Method add_zip_file Undocumented
160 Method addWorkitem Undocumented
152 Method all_meta_types Called by Zope to determine what kind of object the envelope can contain
525 Method areRestrictions Returns 1 if at least a file is restricted from the public, 0 otherwise
319 Method assignWorkitem Assign the specified workitem of the specified instance to the specified actor (string)
168 Method bogus_function Undocumented
815 Method bulkAcceptTime Undocumented
708 Method callAutoPush Undocumented
110 Method callQAEnvelope Calls the envelope-level statistics, based on a script id which is different for each dataflow.
551 Method canAddFeedback Determine whether or not the current user can add manual feedback
545 Method canAddFiles Determine whether or not the content of the envelope can be seen by the current user
563 Method canChangeEnvelope Determine whether or not the current user can change the properties of the envelope
557 Method canEditFeedback Determine whether or not the current user can edit existing manual feedback
66 Method canRunQAOnFiles Returns a list of QA script labels
537 Method canViewContent Determine whether or not the content of the envelope can be seen by the current user
571 Method changeWorkitem use this API to modify anything of a fallout workitem
951 Method complete_task Undocumented
767 Method completeSubflow Undocumented
427 Method completeWorkitem declares the completion of the specified workitem of the given instance
1134 Method convert_data_rivers Undocumented
1388 Method convert_delivery2XML Calls a conversion function from the conversion service via XML-RPC
1038 Method convert_ESRI2XML Undocumented
962 Method convert_esri_to_xml Undocumented
1063 Method convert_excel_rivers Undocumented
1091 Method convert_xml_rivers Undocumented
340 Method create_empty_gml_file Undocumented
320 Method createEmptyGmlFile Undocumented
361 Method delivery_status Status value of the delivery envelope
660 Method endFallinWorkitem Ends the exceptional state of the given workitem
682 Method envelope_zip Go through the envelope and find all the external documents
213 Method envelope_zip_draft Go through the envelope and find all the external documents
635 Method fallinWorkitem the exceptional specified workitem (of the specified instance) will be put back in the activity
613 Method falloutWorkitem drops the workitem in exceptional handling
227 Method fetchFile Grabbs a file from a certain location and uploads it as Report Document
1153 Method fetchXMLFileGW Grabs one XML file from a fixed location and uploads it as Report Document
519 Method forwardWorkitem instructs openflow to forward the specified workitem
282 Method generateFileName Undocumented
300 Method generateGmlFileTitle Undocumented
222 Method getActiveWorkitems returns all active workitems
121 Method getActivity Returns the activity of a workitem
129 Method getApplicationUrl Return application definition URL relative to instance and workitem
138 Method getBaseDocuments returns the 'p_type' documents batched and filtered by 'query'
97 Method getBaseDocumentsCounts returns the count of each type of document
57 Method getCountryCode Returns country ISO code from the country uri
42 Method getCountryName Returns country name from the country uri
498 Method getDestinations Undocumented
266 Method getDocumentsByType Undocumented
166 Method getDocumentsForRemoteService Finds all Report Documents of type XML that have to begin/complete a remote operation
798 Method getEnvelopeDocuments Undocumented
139 Method getEnvironment Returns the engine, the workitem object, the current process and activity
578 Method getFeedbackObjects return sorted feedbacks by their 'title' property, the manual feedback if always first
573 Method getFeedbacks return all the feedbacks
293 Method getGmlFileAssocFactsheet Undocumented
462 Method getHabitatInfo Undocumented
148 Method getInstanceProcessId Returns the process id from its path
168 Method getJoiningWorkitem Undocumented
227 Method getListOfWorkitems Returns all workitems given a list of statuses
593 Method getManualFeedback return manual feedback
481 Method getMapTypes Undocumented
182 Method getMySelf Used to retrieve the envelope object from the workitem
467 Method getNextTransitions Returns the list of transition that the given workitem (of the specified instance)
116 Method getOpenFlowEngine Returns the Collection object, parent of the process
562 Method getPreviousActor Returns the actor that completed the previous workitem
152 Method getProcess Returns the process as an object
70 Method getReferencedFiles Returns the Report Document objects which are referenced in an XML file
471 Method getSpeciesInfo Undocumented
294 Method getStartDate returns the start date in date format
757 Method getSubflowWorkitem TODO!
270 Method getValidXMLSchemas The purpose is to know if to put an edit button and a record in 'view as...' select
280 Method getWebQ_BeforeEditForm_URL Retrieves the URL to the edit for of the XML file - if any
284 Method getWebQ_MenuEnvelope_URL Retrieves the URL to the edit for of the XML file - if any
99 Method getWorkflowTabs Returns the tuple:
673 Method getWorkitemsActiveForMe Returns the list of active workitems
246 Method getXMLFiles Returns a list of the XML files in this envelope.
260 Method getXMLSchemas Gets all the schemas from the contained XML files
603 Method hasFeedbackForThisRelease Returns true if the envelope contains a Report Feedback
54 Method hasFilesForSchema If a values was provided for the p_schema_url, determine whether there are
48 Method hasSpecificFile Checks if an envelope has an XML file with certain schema
374 Method inactivateWorkitem declares the inactivation of the specified workitem of the given instance
213 Method index_html Undocumented
209 Method is_active_for_me returns >0 if there is an active workitem for that person
243 Method isActiveOrRunning Undocumented
461 Method isEnd Undocumented
310 Method linkWorkitems Undocumented
32 Method localities_dict Converts the localities table into a dictionary
745 Method manage_addzipfile Expand a zipfile into a number of Documents.
421 Method manage_changeEnvelope Manage the changed values
186 Method manage_copyDelivery Copies files from another envelope
614 Method manage_deleteFeedback Undocumented
397 Method manage_editEnvelope Manage the edited values
236 Method manage_main Define manage main to be context aware
458 Method manage_restrict Restrict access to the named objects.
471 Method manage_unrestrict Remove access restriction to the named objects.
685 Method manageDummyActivity Undocumented
724 Method manageWorkitemCreation Undocumented
175 Method PrincipiaSearchSource Just return the description.
924 Method process_other_file Undocumented
869 Method process_xml_file Undocumented
626 Method processZipFile Undocumented
540 Method processZipNamelist Undocumented
160 Method PUT_factory If you upload with FTP, it will always create a Document
331 Method release_envelope Releases an envelope to the public
484 Method restrict_editing_files Restrict permission to change files' content.
263 Method resumeInstance resume a specified instance
409 Method resumeWorkitem declares the resumption of the specified workitem of the given instance
76 Method runQAScript Runs the QA script with the specified id against
119 Method runQAScripts Runs multiple QA scripts with the specified file ids
194 Method saveXML Saves the XML file modified by the WebQ as Report Document
627 Method sendWorkitemsToException Undocumented
807 Method setAcceptTime set accepted status
239 Method setPriority Undocumented
179 Method setStatus Undocumented
693 Method startAutomaticApplication Undocumented
294 Method startInstance Starts the flowing of the process instance inside the process definition
743 Method startSubflow Undocumented
247 Method suspendInstance suspend a specified instance
389 Method suspendWorkitem declares the suspension of the specified workitem of the given instance
279 Method terminateInstance terminate a specified instance
851 Method test_filename_species Undocumented
486 Method test_valid_map_name Undocumented
123 Method testAssociatedESRI Undocumented
315 Method testExistingFile Undocumented
494 Method testValidMapName Undocumented
181 Method triggerApplication Triggers remote applications
335 Method unassignWorkitem Unassign the specified workitem
346 Method unrelease_envelope Releases an envelope to the public
496 Method unrestrict_editing_files Remove restriction to change files' content.
370 Method upload_esri_files Undocumented
409 Method upload_gml_file Undocumented
1284 Method upload_MO_delivery Takes a file as input and converts it using a conversion function
356 Method uploadESRIFiles Undocumented
1185 Method uploadGISfiles Undocumented
1217 Method uploadGISZIPfiles Undocumented
395 Method uploadGMLFile Undocumented
208 Method valideObjectProperty Check if a string is a valid sortable property
196 Method validParams Validate sort parameters
780 Method xml returns the envelope metadata in XML format
282 Method years Return the range of years the object pertains to
812 Method zip_to_xml_esri Undocumented
def __init__(self, process, title, authUser, year, endyear, partofyear, country, locality, descr):
overrides Reportek.EnvelopeInstance.EnvelopeInstance.__init__
Envelope constructor
def __setstate__(self, state):
Undocumented
def all_meta_types(self, interfaces=None):
Called by Zope to determine what kind of object the envelope can contain
def PUT_factory(self, name, typ, body):
If you upload with FTP, it will always create a Document
def bogus_function(self):
Undocumented
def PrincipiaSearchSource(self):
Just return the description. Could be enhanced to include all properties
def getMySelf(self):
Used to retrieve the envelope object from the workitem
def manage_copyDelivery(self, previous_delivery, REQUEST=None):
Copies files from another envelope
def index_html(self, REQUEST=None):
Undocumented
def manage_main(self, *args, **kw):
Define manage main to be context aware
def _check_year_range(self):
Swap years if start bigger than end
def years(self):
Return the range of years the object pertains to
def getStartDate(self):
returns the start date in date format
def release_envelope(self, REQUEST=None):
Releases an envelope to the public Must also set the "View" permission on the object?
def unrelease_envelope(self, REQUEST=None):
Releases an envelope to the public Must also remove the "View" permission on the object?
def delivery_status(self):
Status value of the delivery envelope Used for security reasons managing access rights, for tracking whether the delivery is ready to be released, for managing the dataflow by checking what is the next step in the dataflow process
def manage_editEnvelope(self, title, descr, year, endyear, partofyear, country, locality, dataflow_uris=, REQUEST=None):
Manage the edited values
def manage_changeEnvelope(self, title=None, descr=None, year=None, endyear=None, country=None, dataflow_uris=None, reportingdate=None, REQUEST=None):
Manage the changed values
def manage_restrict(self, ids=None, REQUEST=None):
Restrict access to the named objects. Figure out what roles exist, but don't give access to anonymous and authenticated
def manage_unrestrict(self, ids=None, REQUEST=None):
Remove access restriction to the named objects.
def restrict_editing_files(self, REQUEST=None):
Restrict permission to change files' content.
def unrestrict_editing_files(self, REQUEST=None):
Remove restriction to change files' content.
def _set_restrictions(self, ids, roles=, acquire=0, permission='View', REQUEST=None):
Set access to the named objects. This basically finds the objects named in ids and calls the manage_permission on it.
def areRestrictions(self):
Returns 1 if at least a file is restricted from the public, 0 otherwise
def canViewContent(self):
Determine whether or not the content of the envelope can be seen by the current user
def canAddFiles(self):
Determine whether or not the content of the envelope can be seen by the current user
def canAddFeedback(self):
Determine whether or not the current user can add manual feedback
def canEditFeedback(self):
Determine whether or not the current user can edit existing manual feedback
def canChangeEnvelope(self):
Determine whether or not the current user can change the properties of the envelope
def getFeedbacks(self):
return all the feedbacks
def getFeedbackObjects(self):
return sorted feedbacks by their 'title' property, the manual feedback if always first
def getManualFeedback(self):
return manual feedback
def hasFeedbackForThisRelease(self):
Returns true if the envelope contains a Report Feedback for the current release date
def manage_deleteFeedback(self, file_id='', REQUEST=None):
Undocumented
def _copy(self, infile, outfile):
Read binary data from infile and write it to outfile infile and outfile may be strings, in which case a file with that name is opened, or filehandles, in which case they are accessed directly.
def envelope_zip(self, REQUEST, RESPONSE):

Go through the envelope and find all the external documents then zip them and send the result to the user

fixme: It is not impossible that the client only wants part of the zipfile, as in index_html of Document.py due to the partial requests that can be made with HTTP
def _add_file_from_zip(self, zipfile, name, restricted=''):
Generate id from filename and make sure, there are no spaces in the id.
def manage_addzipfile(self, file='', content_type='', restricted='', REQUEST=None):
Expand a zipfile into a number of Documents. Go through the zipfile and for each file in there call self.manage_addProduct['Report Document'].manageaddDocument(id,...
def xml(self, inline='false', REQUEST=None):
returns the envelope metadata in XML format
def getEnvelopeDocuments(self, sortby='id', how='desc'):
Undocumented
def setAcceptTime(self, ids='', sortby='id', how='desc', qs=1, size=20, REQUEST=None):
set accepted status
def bulkAcceptTime(self, ids, action, REQUEST=None):
Undocumented
API Documentation for Reportek, generated by pydoctor at 2007-12-19 11:27:55.