Attribute Manager

class SCC_COMMON_ATTRIBUTE_FW:AttributeManager

This class provides a set of utility methods that can be used to fetch relevant attributes. This class behaves as a sort of object factory that provides attribute objects.

Summary

Constructor Summary

Access Control Details

public

AttributeManager ()

Method Summary

Access Control Details

public boolean

deleteAllAttributes (Record p_parentRec)

Deletes all attributes associated with a record

public array of Attribute

getActiveRecordAttributes (Record p_parentRec)

Returns all active attributes associated with a record

public Attribute

getAttributeFromChildRecord (Record p_childRec)

Returns an Attribute object based on the attribute record

public any

getAttributeValue (Record p_rec, string p_AttributeName)

Returns the value of an attribute from the child record based on the name of the attribute provided

public array of Attribute

getFilteredRecordAttributes(Record p_parentRec, string p_EntityID)

Returns all attributes associated with a record filtered by Entity ID

public Attribute

getRecordAttribute (Record p_parentRec, string p_AttributeName)

Returns attribute associated with a record

public array of Attribute

getRecordAttributes (Record p_parentRec)

Returns all attributes associated with a record

public array of Attribute

getRecordAttributesV2 (Record p_parentRec)

Returns all attributes associated with a record

public void

setAttributeToChildRecord (Record p_childRec out, Attribute p_Attribute)

Sets the correct field in the record with value in the Attribute Object

public void

setAttributeValue (Record p_rec out, string p_AttributeName, any p_AttributeValue)

Sets the value of an attribute from the child record based on the name of the attribute provided

Detail

Constructor Detail

Access Control Details

public

AttributeManager ()

Method Detail

Method Details

deleteAllAttributes

public boolean deleteAllAttributes (Record p_parentRec)

Deletes all attributes associated with a record.

Parameters:

p_parentRec - The record which has been extended with attributes.

Returns:

boolean

getActiveRecordAttributes

public boolean deleteAllAttributes (Record p_parentRec)

Returns all active attributes associated with a record

Parameters:

p_parentRec - The record which has been extended with attributes.

Returns:

Array of Attribute

getAttributeFromChildRecord

public Attribute getAttributeFromChildRecord (Record p_childRec)

Returns an Attribute object based on the attribute record.

Parameters:

p_childRec - The record populated with data from a row in the attribute child record containing the subrecord SCC_CAF_SBR.

Returns:

Attribute

getAttributeValue

public any getAttributeValue (Record p_rec, string p_AttributeName)

Returns the value of an attribute from the child record based on the name of the attribute provided.

Parameters:

  • p_rec - The record populated with data from a row in the attribute child record containing the subrecord SCC_CAF_SBR.

  • p_AttributeName - Name of the attribute as string.

Returns:

any

getFilteredRecordAttributes

public boolean deleteAllAttributes (Record p_parentRec)

Returns all attributes associated with a record filtered by entity ID.

Parameters:

  • p_parentRec - The record which has been extended with attributes.

  • string p_EntityID

Returns:

Array of Attribute

getRecordAttribute

public Attribute getRecordAttribute (Record p_parentRec, string p_AttributeName)

Returns attribute associated with a record.

Parameters:

  • p_parentRec - The record which has been extended with attributes.

  • p_AttributeName - Name of the attribute as string.

Returns:

Attribute

getRecordAttributes

public array of Attribute getRecordAttributes (Record p_parentRec)

Returns all attributes associated with a record.

Parameters:

p_parentRec - The record which has been extended with attributes.

Returns:

array of Attribute

getRecordAttributesV2

public array of Attribute getRecordAttributesV2 (Record p_parentRec)

Returns all attributes associated with a record.

Parameters:

p_parentRec - The record which has been extended with attributes.

Returns:

array of Attribute

setAttributeToChildRecord

public void setAttributeToChildRecord (Record p_childRec out, Attribute p_Attribute)

Sets the correct field in the record with value in the Attribute Object.

Parameters:

  • p_childRec - The record populated with data from a row in the attribute child record containing the subrecord SCC_CAF_SBR.

  • p_Attribute - Instantiated Attribute Object.

setAttributeValue

public void setAttributeValue (Record p_rec out, string p_AttributeName, any p_AttributeValue)

Sets the value of an attribute from the child record based on the name of the attribute provided.

Parameters:

  • p_rec - The record populated with data from a row in the attribute child record containing the subrecord SCC_CAF_SBR.

  • p_AttributeName - Name of the attribute as string.

  • p_AttributeValue - Value of the attribute; data type depends on the attribute type.