cfme.generic_objects.definition.button_groups module

class cfme.generic_objects.definition.button_groups.ButtonAdd(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of GenericObjectAddButtonView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.generic_objects.definition.button_groups.ButtonAll(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW
prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.generic_objects.definition.button_groups.ButtonDetails(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of GenericObjectAddButtonView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.generic_objects.definition.button_groups.ButtonGroupAdd(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of GenericObjectButtonGroupAddView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.generic_objects.definition.button_groups.ButtonGroupAll(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of GenericObjectActionsDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.generic_objects.definition.button_groups.ButtonGroupDetails(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of GenericObjectButtonGroupDetailsView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.generic_objects.definition.button_groups.GenericObjectButton(parent, name, description, image, request, button_type='Default', display=True, dialog=None, open_url=None, display_for=None, submit_version=None, system_message=None, attributes=None, role=None, button_group=None)[source]

Bases: cfme.modeling.base.BaseEntity

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Check equality and either forward a NotImplemented or return the result negated.

__repr__()

Automatically created by attrs.

delete(cancel=False)[source]

Delete generic object button

Args: cancel(bool): By default button will be deleted, pass True to cancel deletion

class cfme.generic_objects.definition.button_groups.GenericObjectButtonGroup(parent, name, description, image, display=True)[source]

Bases: cfme.modeling.base.BaseEntity

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Check equality and either forward a NotImplemented or return the result negated.

__repr__()

Automatically created by attrs.

delete(cancel=False)[source]

Delete generic object button group

Args: cancel(bool): By default group will be deleted, pass True to cancel deletion

class cfme.generic_objects.definition.button_groups.GenericObjectButtonGroupsCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection

ENTITY

alias of GenericObjectButtonGroup

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Check equality and either forward a NotImplemented or return the result negated.

__repr__()

Automatically created by attrs.

all()[source]

All existing button groups

Returns: list of button groups objects

create(name, description, image, display=True, cancel=False)[source]

Add button group for generic object definition

Parameters:
  • name (str) – button group name
  • description (str) – button group description
  • image (str) – button group image
  • display (bool) – parameter to display button group on UI or not, default is True
  • cancel (bool) – cancel button creation, default if False

Returns: button group object

class cfme.generic_objects.definition.button_groups.GenericObjectButtonsCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection

ENTITY

alias of GenericObjectButton

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Check equality and either forward a NotImplemented or return the result negated.

__repr__()

Automatically created by attrs.

all()[source]

All existing buttons

Returns: list of buttons objects

create(name, description, request, image, button_type='Default', display=True, dialog=None, open_url=None, display_for=None, submit_version=None, system_message=None, attributes=None, role=None, cancel=False)[source]

Add button to generic object definition or button group

Parameters:
  • name (str) – button name
  • description (str) – button description
  • request (str) – button request type
  • image (str) – button image
  • button_type (str) – button type
  • display (bool) – parameter to display button on UI or not, default is True
  • dialog (str) – button dialog
  • open_url (str) – button open_url
  • display_for (str) – for which item this button should be displayed
  • submit_version (str) – how this button should be submited, ex. ‘One by one’
  • system_message (str) – button submit message
  • attributes (dict) – button attributes ex. {‘address’: ‘string’}
  • role – role used for button
  • cancel (bool) – cancel button creation, default if False

Returns: button object