airgun.entities.filter

Module Contents

Classes

FilterEntity
ShowAllFilters	Navigate to All Role Filters page by pressing 'Filters' button on Roles
AddNewFilter	Navigate to role's Create Filter page
EditFilter	Navigate to role's Edit Filter page

class airgun.entities.filter.FilterEntity(browser)

create(role_name, values)

Create new filter for specific role

search(role_name, value)

Search for filter assigned to the role

read(role_name, entity_name, widget_names=None)

Read values for specific filter

read_all(role_name)

Read all the available role filters table values

read_permissions(role_name)

Return all role filters permissions as a dict with resources as keys and permission names as values.

update(role_name, entity_name, values)

Update filter values

delete(role_name, entity_name)

Delete specific filter from role

class airgun.entities.filter.ShowAllFilters(obj, navigate_obj, logger=None)

Navigate to All Role Filters page by pressing ‘Filters’ button on Roles List view.

Parameters

role_name – name of role

VIEW

am_i_here(*args, **kwargs)

Describes if the navigation is already at the requested destination.

By default, airgun relies on view’s is_displayed property to determine whether navigation succeeded. If positional argument entity_name was passed and view has BreadCrumb widget, it will also ensure second location in breadcrumb is provided entity name.

This method may be overridden on specific entity’s NavigateStep level for more complex logic if needed.

Returns

whether navigator is at requested destination or not.

Return type

bool

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.filter.AddNewFilter(obj, navigate_obj, logger=None)

Navigate to role’s Create Filter page

Parameters

• role_name – name of role

• entity_name – name of filter

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.filter.EditFilter(obj, navigate_obj, logger=None)

Navigate to role’s Edit Filter page

Parameters

• role_name – name of role

• entity_name – name of filter

VIEW

am_i_here(*args, **kwargs)

Describes if the navigation is already at the requested destination.

By default, airgun relies on view’s is_displayed property to determine whether navigation succeeded. If positional argument entity_name was passed and view has BreadCrumb widget, it will also ensure second location in breadcrumb is provided entity name.

This method may be overridden on specific entity’s NavigateStep level for more complex logic if needed.

Returns

whether navigator is at requested destination or not.

Return type

bool

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.