UiSelection

class q2_sdk.hq.db.ui_selection.UiSelectionRow[source]

Bases: RepresentationRowBase

UiSelectionID: IntElement = 'UiSelectionID'
ShortName: StringElement = 'ShortName'
Description: StringElement = 'Description'
UiLanguageID: IntElement = 'UiLanguageID'
UiStyleSetID: IntElement = 'UiStyleSetID'
UuxThemeID: IntElement = 'UuxThemeID'
IsCentralTheme: BoolElement = 'IsCentralTheme'
NavigationID: IntElement = 'NavigationID'
class q2_sdk.hq.db.ui_selection.UiSelection(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:
  • logger – Reference to calling request’s logger (self.logger in your extension)

  • hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)

  • ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

GET_BY_NAME_KEY = 'ShortName'
NAME = 'UiSelection ShortName'
REPRESENTATION_ROW_CLASS

alias of UiSelectionRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)[source]
Return type:

List[UiSelectionRow]

async get_by_name(name, **kwargs)[source]
Return type:

UiSelectionRow