browser.async - Browser Job Components

class waeup.kofa.browser.async.DataCenterJSON(context, request)[source]

Bases: grok.components.JSON

__doc__ = None
__module__ = 'waeup.kofa.browser.async'
status()[source]

Get status of currently handled export jobs for users.

The result is a set of valus useful for JavaScript handlers to update some page handling data center exports.

Returns a mapping:

{html=<string>, interval=<int>, reload=<bool>}

where html is some HTML code that might be shown in a loading bar section.

interval is the time in microseconds after which the loading bar should be reloaded (by a new JSON call). If the value is zero, then the loading bar should not be renewed and further JSON calls be canceled.

reload is a hint to tell, whether the complete page should be reloaded or not. Reloading is neccessary, if the export file creation finished and download buttons or similar should appear.

class waeup.kofa.browser.async.JobManagerView(context, request)[source]

Bases: waeup.kofa.browser.layout.KofaPage

The main view for the job container.

__doc__ = 'The main view for the job container.\n '
__module__ = 'waeup.kofa.browser.async'
jobs()[source]
update(START_NEW=None, REMOVE=None, job_id=None)[source]
class waeup.kofa.browser.async.JobView(context, request)[source]

Bases: grok.components.View

__doc__ = None
__module__ = 'waeup.kofa.browser.async'
percent()[source]
update()[source]
class waeup.kofa.browser.async.LoadingBar(context, request, view)[source]

Bases: grokcore.viewlet.components.ViewletManager

__doc__ = None
__module__ = 'waeup.kofa.browser.async'
class waeup.kofa.browser.async.LoadingBarViewlet(context, request, view, manager)[source]

Bases: grokcore.viewlet.components.Viewlet

__doc__ = None
__module__ = 'waeup.kofa.browser.async'
_running_exports = None
getRunningExports()[source]

Returns running exports as list of tuples.

Only exports triggered by the current user (identified by principal.id) are returned.

Each tuple has the form (<STATUS>, <STATUS_TITLE>, <EXPORTER_NAME>).

STATUS:
the status as machine readable string (something like 'completed')
STATUS_TITLE:
status of export as translated string.
EXPORTER_NAME:
string representing the exporter title used when triggering the export job.
render()[source]
update()[source]