CCPAttribute
An attribute of a complex product. CCPAttribute
interface CCPAttribute {
'conflicts'?: Array<CCPConflict>;
'domainValues'?: Array<CCPAttributeValue>;
'formattedValue'?: string;
'images'?: Array<Image>;
'intervalInDomain'?: boolean;
'key'?: string;
'langDepName'?: string;
'longText'?: string;
'maxlength'?: number;
'messages'?: Array<CCPMessage>;
'name'?: string;
'negativeAllowed'?: boolean;
'numberScale'?: number;
'required'?: boolean;
'retractBlocked'?: boolean;
'retractTriggered'?: boolean;
'type'?: CCPAttributeTypeEnum;
'typeLength'?: number;
'validationType'?: CCPAttributeValidationTypeEnum;
'value'?: string;
'visible'?: boolean;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
conflicts | Optional | Array<CCPConflict> | List of conflicts. {Array<CCPConflict>} CCPAttribute |
domainValues | Optional | Array<CCPAttributeValue> | List of domain values. {Array<CCPAttributeValue>} CCPAttribute |
formattedValue | Optional | string | Formatted attribute value, relevant for numeric attributes. This formatting takes the session locale into account. {string} CCPAttribute |
images | Optional | Array<Image> | Image list. {Array<Image>} CCPAttribute |
intervalInDomain | Optional | boolean | The list of attribute domain values contain an interval. Only relevant if the attribute is of numeric type. {boolean} CCPAttribute |
key | Optional | string | Language-independent attribute key. {string} CCPAttribute |
langDepName | Optional | string | Language-dependent attribute description. {string} CCPAttribute |
longText | Optional | string | Language-dependent attribute long description. {string} CCPAttribute |
maxlength | Optional | number | Maximum length of attribute value names for all domain values. {number} CCPAttribute |
messages | Optional | Array<CCPMessage> | Message list. {Array<CCPMessage>} CCPAttribute |
name | Optional | string | Language-independent attribute name as assigned in the modeling environment. {string} CCPAttribute |
negativeAllowed | Optional | boolean | Are negative values allowed? Only relevant if the attribute is of numeric type. {boolean} CCPAttribute |
numberScale | Optional | number | Number of decimal places. Only relevant if the attribute is of numeric type. {number} CCPAttribute |
required | Optional | boolean | It is required to specify this attribute in order to complete the configuration. {boolean} CCPAttribute |
retractBlocked | Optional | boolean | Retract must never happen for this attribute because the configuration engine forbids it. {boolean} CCPAttribute |
retractTriggered | Optional | boolean | Has a retract been triggered for all values of this attribute? {boolean} CCPAttribute |
type | Optional | CCPAttributeTypeEnum | Attribute type. Specifies how the attribute should be rendered ideally. {string} CCPAttribute |
typeLength | Optional | number | Maximum number of decimal places. Only relevant if the attribute is of numeric type. {number} CCPAttribute |
validationType | Optional | CCPAttributeValidationTypeEnum | Attribute validation type. Specifies how an attribute should be validated in case it's free input. {string} CCPAttribute |
value | Optional | string | Attribute value, if the attribute is single-valued. {string} CCPAttribute |
visible | Optional | boolean | Attribute is visible. {boolean} CCPAttribute |