AttributeDef¶

class AttributeDef¶

API for a plain attribute definition.

Returned by

• AttributeSpecApi.CreateAttributeDef

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

AttributeDef

GetGroup()¶

Returns the group of the attribute definition.

Returns:

Group name of the attribute definition or None

Return type:

str

GetIdentifier()¶

Returns the identifier of the attribute definition.

Returns:

Identifier of the attribute definition

Return type:

str

GetLabel()¶

Returns the label of the attribute definition.

Returns:

Display label of the attribute definition or None

Return type:

str

IsReadOnly()¶

Returns if the attribute is read-only.

Returns:

True if read-only, otherwise False

Return type:

bool

IsRequired()¶

Returns if the attribute is required.

Returns:

True if required, otherwise False

Return type:

bool

SetGroup(group)¶

Sets the group of the attribute definition.

Parameters:

group : str¶

Group name of the attribute definition

SetLabel(label)¶

Sets the label of the attribute definition.

Parameters:

label : str¶

Display label of the attribute definition

SetReadOnly(readOnly)¶

Sets if the attribute is read-only.

Parameters:

readOnly : bool¶

True if read-only, otherwise False

SetRequired(required)¶

Sets if the attribute is required.

Parameters:

required : bool¶

True if required, otherwise False