rql_download.entities.IFSetAdapter

class rql_download.entities.IFSetAdapter(req, **extra)

Action to download ExternalFile entities to a FileSet entity.

Warning

• The adapted RQL must return the file pathes in the first item of the rset.

Methods

__init__(req, **extra)
actual_actions()
build_action(title, url, **kwargs)
critical(msg, *args, **kwargs)	Log ‘msg % args’ with severity ‘CRITICAL’.
cw_propval(propid)	return cw property value associated to key
debug(msg, *args, **kwargs)	Log ‘msg % args’ with severity ‘DEBUG’.
error(msg, *args, **kwargs)	Log ‘msg % args’ with severity ‘ERROR’.
exception(msg, *args, **kwargs)	Convenience method for logging an ERROR with exception information.
fill_menu(box, menu)	add action(s) to the given submenu of the given box
html_class()
info(msg, *args, **kwargs)	Log ‘msg % args’ with severity ‘INFO’.
rql(rql, parameter_name[, identifier])	Method that patch the rql.
url()	return the url associated with this action
warning(msg, *args, **kwargs)	Log ‘msg % args’ with severity ‘WARNING’.

Attributes

category
order
submenu

__module__ = 'rql_download.entities'

__regid__ = 'rqldownload-adapters'

rql(rql, parameter_name, identifier=1)

Method that patch the rql.

Note

• reserved keys are ‘PATH’, ‘FENTRIES’ postfixed with the identifier number.
• returned files are necessary at the beginning of the adapted rql.

Parameters:

rql: str (mandatory) :

the request to adapt.

parameter_name: str (mandatory) :

the label of the entity to adapt.

identifier: int (optional) :

postfix the reserved keys with this identifier.

Returns:

global_rql: str :

the adapted rql.

nb_files: int :

the number of files returned at the begining of the result set.