airgun.entities.report_template

Module Contents

Classes

ReportTemplateEntity
ShowAllReportTemplates	Navigate to all Report Templates screen.
AddNewReportTemplate	Navigate to Create new Report Template screen.
EditReportTemplate	Navigate to Edit Report Template screen.
CloneReportTemplate	Navigate to Create Report Template screen for cloned entity
GenerateReportTemplate	Navigate to Generate a Report Template.

class airgun.entities.report_template.ReportTemplateEntity(browser)

endpoint_path = /templates/report_templates

create(values)

Create new report template

search(value)

Search for existing report template

read(entity_name, widget_names=None)

Read report template values

clone(entity_name, values)

Clone existing report template

lock(entity_name)

Lock report template for editing

unlock(entity_name)

Unlock report template for editing

is_locked(entity_name)

Check if report template is locked for editing

export(entity_name)

Export report template.

Return str

path to saved file

generate(entity_name, values={})

Generate report template

Return str

path to saved file

schedule(entity_name, values={})

Schedule report template

update(entity_name, values)

Update report template

delete(entity_name)

Delete report template

class airgun.entities.report_template.ShowAllReportTemplates(obj, navigate_obj, logger=None)

Navigate to all Report Templates screen.

VIEW

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.report_template.AddNewReportTemplate(obj, navigate_obj, logger=None)

Navigate to Create new Report Template screen.

VIEW

prerequisite

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.report_template.EditReportTemplate(obj, navigate_obj, logger=None)

Navigate to Edit Report Template screen.

Parameters

entity_name – name of report template to edit

VIEW

prerequisite(*args, **kwargs)

Describes a step that must be carried our prior to this one.

This often calls a previous navigate_to, often using one of the helpers, NavigateToSibling which will navigate to a given destination using the same object, or NavigateToAttribute which will navigate to a destination against an object describe by the attribute of the parent object.

This is a default and is generally overridden.

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.report_template.CloneReportTemplate(obj, navigate_obj, logger=None)

Navigate to Create Report Template screen for cloned entity

Parameters

entity_name – name of report template to clone

VIEW

prerequisite(*args, **kwargs)

Describes a step that must be carried our prior to this one.

This often calls a previous navigate_to, often using one of the helpers, NavigateToSibling which will navigate to a given destination using the same object, or NavigateToAttribute which will navigate to a destination against an object describe by the attribute of the parent object.

This is a default and is generally overridden.

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.report_template.GenerateReportTemplate(obj, navigate_obj, logger=None)

Navigate to Generate a Report Template.

VIEW

prerequisite(*args, **kwargs)

Describes a step that must be carried our prior to this one.

This often calls a previous navigate_to, often using one of the helpers, NavigateToSibling which will navigate to a given destination using the same object, or NavigateToAttribute which will navigate to a destination against an object describe by the attribute of the parent object.

This is a default and is generally overridden.

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.