ObjectGroupData

class q2_sdk.hq.db.object_group.ObjectGroupDataRow

Bases: RepresentationRowBase

ObjectGroupID: StringElement = 'ObjectGroupID'

ObjectGroupTypeID: IntElement = 'ObjectGroupTypeID'

ShortName: StringElement = 'ShortName'

Data: StringElement = 'Data'

Alias: StringElement = 'Alias'

UserID: IntElement = 'UserID'

ObjectGroupTypeID1: IntElement = 'ObjectGroupTypeID1'

ShortName1: StringElement = 'ShortName1'

UiTextElementID1: IntElement = 'UiTextElementID1'

class q2_sdk.hq.db.object_group.ObjectGroupData(logger, hq_credentials=None, ret_table_obj=None)

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 = 'ObjectGroup'

REPRESENTATION_ROW_CLASS

alias of ObjectGroupDataRow

async get(user_id, object_group_type)

Return type:

List[ObjectGroupDataRow]

async get_by_id(object_group_id)

Return type:

List[ObjectGroupDataRow]

async add(short_name, object_group_type, alias, data, description=None, user_id=None, ui_text_element=None, customer_id=None)

Return type:

None

async update(object_group_id, short_name=<DEFAULT_DB_PARAM>, object_group_type_id=<DEFAULT_DB_PARAM>, alias=<DEFAULT_DB_PARAM>, data=<DEFAULT_DB_PARAM>, user_id=<DEFAULT_DB_PARAM>)