Class KLPartialGroupSetting

Set of parameters describing partial group of possible KL-attributes.
inherits from LMWrap
namespace: lm.tasks.settings

Constructor

KLPartialGroupSetting()

Creates a new object of this class

Parameters

• luaTable - to store named parameters

Obligatory named parameters

• pTaskKL : TaskKL - to which this partial group setting belongs
• nCedentTypeCode : integer - CedentType code to identify the partial group to find

Optional named parameters

• name : string - optional name description for the new partial group
• nOrder : integer - position of the partial group in the list of partial groups of its whole setting

Properties List

Description	Textual description of this partial group. Deprecated!
ID	Unique identifier (primary key) of the object
Name	Textual description of this partial group
Note	Additional note to this partial group
Order	Order-index of this partial group in array of partial groups of its TaskKL
TaskKL	the TaskKL, this partial group belongs to

Methods List

canDel ()	Returns true if the object could be deleted (is not used)
findKLAttributeSetting ()	Tries to look-up a KLAttributeSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLAttributeSetting with this property doesn't exists.
getCedentTypeCode ()	Returns code of type of partial group, see CedentType codes
getCedentTypeKey ()	Returns unique string key of type of partial group
getCedentTypeName ()	Returns string representation of type of partial group
getDescription ()	Returns the value of Description property
getID ()	Returns unique identifier (primary key) of the object
getKLAttributeSettingCount ()	Returns number of KLAttributeSettings in this partial group
getName ()	Returns the value of Name property
getNote ()	Returns the value of Note property
getOrder ()	Returns the value of Order property
getTaskKL ()	Returns the TaskKL this partial group setting belongs to, the value of TaskKL property
onAdd ()	Store the newly created object into metabase
onDel ()	Delete the object from metabase (fails if canDel returns false)
onUpdate ()	Save changes made to the object into metabase
prepareKLAttributeSettingArray ()	Returns array of KLAttributeSettings (attributes in this partial group)
setDescription ()	Sets the value of Description property
setName ()	Sets the value of Name property
setNote ()	Sets the value of Note property
setOrder ()	Sets the value of Order property

Properties

Description : string

Textual description of this partial group. Deprecated!

ID  (read-only) : integer

Unique identifier (primary key) of the object
Intherited from: LMWrap

Name : string

Textual description of this partial group

Note : string

Additional note to this partial group

Order : integer

Order-index of this partial group in array of partial groups of its TaskKL

TaskKL  (read-only) : TaskKL

the TaskKL, this partial group belongs to

Methods

canDel() : boolean

Returns true if the object could be deleted (is not used)
Intherited from: LMWrap

Returns

• boolean

findKLAttributeSetting() : KLAttributeSetting

Tries to look-up a KLAttributeSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLAttributeSetting with this property doesn't exists.

Parameters

• luaTable - to store named parameters

Optional named parameters

• nID : integer - an ID of the KLAttributeSetting to look-up
• pAttribute : Attribute - the setting should be based on (return the first attribute setting matching the condition)

Returns

• KLAttributeSetting - or nil

getCedentTypeCode() : integer

Returns code of type of partial group, see CedentType codes

Returns

• integer

getCedentTypeKey() : string

Returns unique string key of type of partial group

Returns

• string

getCedentTypeName() : string

Returns string representation of type of partial group

Returns

• string

getDescription() : string

Returns the value of Description property

Returns

• string

getID() : integer

Returns unique identifier (primary key) of the object
Intherited from: LMWrap

Returns

• integer

getKLAttributeSettingCount() : integer

Returns number of KLAttributeSettings in this partial group

Returns

• integer

getName() : string

Returns the value of Name property

Returns

• string

getNote() : string

Returns the value of Note property

Returns

• string

getOrder() : integer

Returns the value of Order property

Returns

• integer

getTaskKL() : TaskKL

Returns the TaskKL this partial group setting belongs to, the value of TaskKL property

Returns

• TaskKL

onAdd()

Store the newly created object into metabase
Intherited from: LMWrap

onDel()

Delete the object from metabase (fails if canDel returns false)
Intherited from: LMWrap

onUpdate()

Save changes made to the object into metabase
Intherited from: LMWrap

prepareKLAttributeSettingArray() : luaTable

Returns array of KLAttributeSettings (attributes in this partial group)

Returns

• luaTable

setDescription( string )

Sets the value of Description property

Parameters

• string

setName( string )

Sets the value of Name property

Parameters

• string

setNote( string )

Sets the value of Note property

Parameters

• string

setOrder( integer )

Sets the value of Order property

Parameters

• integer