CsticModel (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

All Superinterfaces:

BaseModel, Cloneable

All Known Implementing Classes:

CsticModelImpl
```
public interface CsticModel
extends BaseModel
```
Represents the characteristic model.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTHOR_DEFAULT`
`static String`	`AUTHOR_NOAUTHOR`
`static String`	`AUTHOR_SYSTEM`
`static String`	`AUTHOR_USER`
`static int`	`TYPE_BOOLEAN` Value type for boolean
`static int`	`TYPE_CLASS` Value type for object class (materials)
`static int`	`TYPE_CURRENCY` Value type for currency
`static int`	`TYPE_DATE` Value type for date
`static int`	`TYPE_FLOAT` Value type for float
`static int`	`TYPE_INTEGER` Value type for integer
`static int`	`TYPE_STRING` Value type for String
`static int`	`TYPE_TIME` Value type for time
`static int`	`TYPE_UNDEFINED`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addValue(String valueName)` Assigns the given value to the characteristic, while keeping any previous value assignments. This is a typical operation for multi valued characteristics.
`void`	`clearValues()` clears all assigned Values, same as setting an empty List as assigned value list
`CsticModel`	`clone()` We need our models to be cloneable since the configurator mock implementation uses clone for creating new entities.
`List<CsticValueModel>`	`getAssignableValues()`
`List<CsticValueModel>`	`getAssignedValues()`
`String`	`getAuthor()`
`String`	`getEntryFieldMask()`
`String`	`getInstanceId()`
`String`	`getLanguageDependentName()`
`String`	`getLongText()` Get the long text description for a cstic, which will be displayed under the cstic name in the UI
`String`	`getName()`
`int`	`getNumberScale()`
`String`	`getPlaceholder()`
`String`	`getSingleValue()` Gets the first value of the assigned Values if existing, or null otherwise.
`int`	`getStaticDomainLength()`
`int`	`getTypeLength()`
`int`	`getValueType()`
`boolean`	`isAllowsAdditionalValues()`
`boolean`	`isChangedByFrontend()`
`boolean`	`isComplete()`
`boolean`	`isConsistent()`
`boolean`	`isConstrained()`
`boolean`	`isIntervalInDomain()`
`boolean`	`isMultivalued()`
`boolean`	`isReadonly()`
`boolean`	`isRequired()`
`boolean`	`isRetractTriggered()`
`boolean`	`isVisible()`
`boolean`	`removeAssignableValue(String valueName)`
`void`	`removeValue(String valueName)` Remove the given value from the assigned values, while keeping the other value assignments. This is a typical operation for multi valued characteristics.
`void`	`setAllowsAdditionalValues(boolean booleanValue)`
`void`	`setAssignableValues(List<CsticValueModel> assignableValues)`
`void`	`setAssignedValues(List<CsticValueModel> assignedValues)`
`void`	`setAssignedValuesWithoutCheckForChange(List<CsticValueModel> assignedValues)` sets assigned value without to check whether the characteristic was changed
`void`	`setAuthor(String author)`
`void`	`setChangedByFrontend(boolean changedByFrontend)`
`void`	`setComplete(boolean complete)`
`void`	`setConsistent(boolean consistent)`
`void`	`setConstrained(boolean constrained)`
`void`	`setEntryFieldMask(String csticEntryFieldMask)`
`void`	`setInstanceId(String instanceId)`
`void`	`setIntervalInDomain(boolean intervalInDomain)`
`void`	`setLanguageDependentName(String languageDependentName)`
`void`	`setLongText(String longText)` Set the long text, which will be displayed under the Cstic name in the UI
`void`	`setMultivalued(boolean multivalued)`
`void`	`setName(String name)`
`void`	`setNumberScale(int numberScale)`
`void`	`setPlaceholder(String placeHolder)`
`void`	`setReadonly(boolean readonly)`
`void`	`setRequired(boolean required)`
`void`	`setRetractTriggered(boolean b)`
`void`	`setSingleValue(String valueName)` Assigns the given value to the characteristic, overwriting any previous value assignments. This is a typical operation for single valued characteristics.
`void`	`setStaticDomainLength(int staticDomainLength)`
`void`	`setTypeLength(int typeLength)`
`void`	`setValueType(int valueType)`
`void`	`setVisible(boolean visble)`

Methods inherited from interface de.hybris.platform.sap.productconfig.runtime.interf.model.BaseModel
getExtensionData, getExtensionMap, putExtensionData, setExtensionMap

- Field Detail
  - TYPE_UNDEFINED
```
static final int TYPE_UNDEFINED
```
    See Also:
    
    Constant Field Values
  - TYPE_STRING
```
static final int TYPE_STRING
```
    Value type for String
    
    See Also:
    
    Constant Field Values
  - TYPE_INTEGER
```
static final int TYPE_INTEGER
```
    Value type for integer
    
    See Also:
    
    Constant Field Values
  - TYPE_FLOAT
```
static final int TYPE_FLOAT
```
    Value type for float
    
    See Also:
    
    Constant Field Values
  - TYPE_BOOLEAN
```
static final int TYPE_BOOLEAN
```
    Value type for boolean
    
    See Also:
    
    Constant Field Values
  - TYPE_DATE
```
static final int TYPE_DATE
```
    Value type for date
    
    See Also:
    
    Constant Field Values
  - TYPE_TIME
```
static final int TYPE_TIME
```
    Value type for time
    
    See Also:
    
    Constant Field Values
  - TYPE_CURRENCY
```
static final int TYPE_CURRENCY
```
    Value type for currency
    
    See Also:
    
    Constant Field Values
  - TYPE_CLASS
```
static final int TYPE_CLASS
```
    Value type for object class (materials)
    
    See Also:
    
    Constant Field Values
  - AUTHOR_SYSTEM
```
static final String AUTHOR_SYSTEM
```
    See Also:
    
    Constant Field Values
  - AUTHOR_USER
```
static final String AUTHOR_USER
```
    See Also:
    
    Constant Field Values
  - AUTHOR_DEFAULT
```
static final String AUTHOR_DEFAULT
```
    See Also:
    
    Constant Field Values
  - AUTHOR_NOAUTHOR
```
static final String AUTHOR_NOAUTHOR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    the characteristic name
  - setName
```
void setName(String name)
```
    Parameters:
    
    name - characteristic name
  - getLanguageDependentName
```
String getLanguageDependentName()
```
    Returns:
    
    the characteristic language dependent name
  - setLanguageDependentName
```
void setLanguageDependentName(String languageDependentName)
```
    Parameters:
    
    languageDependentName - characteristic language dependent name
  - getLongText
```
String getLongText()
```
    Get the long text description for a cstic, which will be displayed under the cstic name in the UI
    
    Returns:
    
    The long text value
  - setLongText
```
void setLongText(String longText)
```
    Set the long text, which will be displayed under the Cstic name in the UI
    
    Parameters:
    
    longText - Description for the cstic
  - getAssignedValues
```
List<CsticValueModel> getAssignedValues()
```
    Returns:
    
    an unmodifiable list of all assigned values
  - setAssignedValuesWithoutCheckForChange
```
void setAssignedValuesWithoutCheckForChange(List<CsticValueModel> assignedValues)
```
    sets assigned value without to check whether the characteristic was changed
    
    Parameters:
    
    assignedValues - list of all assigned values
  - setAssignedValues
```
void setAssignedValues(List<CsticValueModel> assignedValues)
```
    Parameters:
    
    assignedValues - list of all assigned values
  - getAssignableValues
```
List<CsticValueModel> getAssignableValues()
```
    Returns:
    
    an unmodifiable list of all assignable values
  - setAssignableValues
```
void setAssignableValues(List<CsticValueModel> assignableValues)
```
    Parameters:
    
    assignableValues - list of all assignable values
  - getValueType
```
int getValueType()
```
    Returns:
    
    the value type
  - setValueType
```
void setValueType(int valueType)
```
    Parameters:
    
    valueType - value type
  - getTypeLength
```
int getTypeLength()
```
    Returns:
    
    the length of the characteristic value type
  - setTypeLength
```
void setTypeLength(int typeLength)
```
    Parameters:
    
    typeLength - length of the characteristic value type
  - getNumberScale
```
int getNumberScale()
```
    Returns:
    
    the number scale
  - setNumberScale
```
void setNumberScale(int numberScale)
```
    Parameters:
    
    numberScale - the number scale
  - isVisible
```
boolean isVisible()
```
    Returns:
    
    true if the characteristic is visible
  - setVisible
```
void setVisible(boolean visble)
```
    Parameters:
    
    visble - flag indicating whether the characteristic is visible
  - isConsistent
```
boolean isConsistent()
```
    Returns:
    
    true if the characteristic is consistent
  - setConsistent
```
void setConsistent(boolean consistent)
```
    Parameters:
    
    consistent - flag indicating whether the characteristic is consistent
  - isComplete
```
boolean isComplete()
```
    Returns:
    
    true if the characteristic is complete
  - setComplete
```
void setComplete(boolean complete)
```
    Parameters:
    
    complete - flag indicating whether the characteristic is complete
  - isReadonly
```
boolean isReadonly()
```
    Returns:
    
    true if the characteristic is read only
  - setReadonly
```
void setReadonly(boolean readonly)
```
    Parameters:
    
    readonly - flag indicating whether the characteristic is read only
  - isRequired
```
boolean isRequired()
```
    Returns:
    
    true if the characteristic is required
  - setRequired
```
void setRequired(boolean required)
```
    Parameters:
    
    required - flag indicating whether the characteristic is required
  - isMultivalued
```
boolean isMultivalued()
```
    Returns:
    
    true if the characteristic is multivalued
  - setMultivalued
```
void setMultivalued(boolean multivalued)
```
    Parameters:
    
    multivalued - flag indicating whether the characteristic is multivalued
  - isChangedByFrontend
```
boolean isChangedByFrontend()
```
    Returns:
    
    true if the characteristic is changed by front end
  - setChangedByFrontend
```
void setChangedByFrontend(boolean changedByFrontend)
```
    Parameters:
    
    changedByFrontend - flag indicating whether the characteristic is changed by front end
  - clone
```
CsticModel clone()
```
    Description copied from interface: BaseModel
    
    We need our models to be cloneable since the configurator mock implementation uses clone for creating new entities.
    
    Specified by:
    
    clone in interface BaseModel
    
    Returns:
    
    cloned CsticModel
  - getAuthor
```
String getAuthor()
```
    Returns:
    
    the characteristic author
  - setAuthor
```
void setAuthor(String author)
```
    Parameters:
    
    author - haracteristic author
  - setSingleValue
```
void setSingleValue(String valueName)
```
    Assigns the given value to the characteristic, overwriting any previous value assignments.
    This is a typical operation for single valued characteristics.
    
    Parameters:
    
    valueName - the value to set
  - addValue
```
void addValue(String valueName)
```
    Assigns the given value to the characteristic, while keeping any previous value assignments.
    This is a typical operation for multi valued characteristics.
    
    Parameters:
    
    valueName - the value to add
  - removeValue
```
void removeValue(String valueName)
```
    Remove the given value from the assigned values, while keeping the other value assignments.
    This is a typical operation for multi valued characteristics.
    
    Parameters:
    
    valueName - the value to add
  - getSingleValue
```
String getSingleValue()
```
    Gets the first value of the assigned Values if existing, or null otherwise. This is a typical operation for single valued characteristics.
    
    Returns:
    
    first value of assigned values
  - clearValues
```
void clearValues()
```
    clears all assigned Values, same as setting an empty List as assigned value list
  - setAllowsAdditionalValues
```
void setAllowsAdditionalValues(boolean booleanValue)
```
    Parameters:
    
    booleanValue - true, only if this characteristic allow additional values
  - getEntryFieldMask
```
String getEntryFieldMask()
```
    Returns:
    
    the characteristic entry field mask for user input
  - isAllowsAdditionalValues
```
boolean isAllowsAdditionalValues()
```
    Returns:
    
    true only if this characteristic allow additional values
  - setEntryFieldMask
```
void setEntryFieldMask(String csticEntryFieldMask)
```
    Parameters:
    
    csticEntryFieldMask - characteristic entry field mask for user input
  - isIntervalInDomain
```
boolean isIntervalInDomain()
```
    Returns:
    
    true if the characteristic values are intervals in domain
  - setIntervalInDomain
```
void setIntervalInDomain(boolean intervalInDomain)
```
    Parameters:
    
    intervalInDomain - flag indicating whether the characteristic values are intervals in domain
  - isConstrained
```
boolean isConstrained()
```
    Returns:
    
    true if the characteristic is constrained
  - setConstrained
```
void setConstrained(boolean constrained)
```
    Parameters:
    
    constrained - flag indicating whether the characteristic is constrained
  - getStaticDomainLength
```
int getStaticDomainLength()
```
    Returns:
    
    the length of the characteristic static domain
  - setStaticDomainLength
```
void setStaticDomainLength(int staticDomainLength)
```
    Parameters:
    
    staticDomainLength - length of the characteristic static domain
  - getPlaceholder
```
String getPlaceholder()
```
    Returns:
    
    the place holder for input field
  - setPlaceholder
```
void setPlaceholder(String placeHolder)
```
    Parameters:
    
    placeHolder - place holder for input field
  - setInstanceId
```
void setInstanceId(String instanceId)
```
    Parameters:
    
    instanceId - ID of corresponding instance. See InstanceModel.getId()
  - getInstanceId
```
String getInstanceId()
```
    Returns:
    
    ID of corresponding instance. See InstanceModel.getId()
  - setRetractTriggered
```
void setRetractTriggered(boolean b)
```
    Parameters:
    
    b - This characteristic is supposed to be retracted i.e. the user inputs are withdrawn
  - isRetractTriggered
```
boolean isRetractTriggered()
```
    Returns:
    
    Is this characteristic supposed to be retracted?
  - removeAssignableValue
```
boolean removeAssignableValue(String valueName)
```
    Parameters:
    
    valueName - value to be removed from the list of assignable values
    
    Returns:
    
    true if the value was removed from the list of assignable values

Interface CsticModel

Field Summary

Method Summary

Methods inherited from interface de.hybris.platform.sap.productconfig.runtime.interf.model.BaseModel

Field Detail

TYPE_UNDEFINED

TYPE_STRING

TYPE_INTEGER

TYPE_FLOAT

TYPE_BOOLEAN

TYPE_DATE

TYPE_TIME

TYPE_CURRENCY

TYPE_CLASS

AUTHOR_SYSTEM

AUTHOR_USER

AUTHOR_DEFAULT

AUTHOR_NOAUTHOR

Method Detail

getName

setName

getLanguageDependentName

setLanguageDependentName

getLongText

setLongText

getAssignedValues

setAssignedValuesWithoutCheckForChange

setAssignedValues

getAssignableValues

setAssignableValues

getValueType

setValueType

getTypeLength

setTypeLength

getNumberScale

setNumberScale

isVisible

setVisible

isConsistent

setConsistent

isComplete

setComplete

isReadonly

setReadonly

isRequired

setRequired

isMultivalued

setMultivalued

isChangedByFrontend

setChangedByFrontend

clone

getAuthor

setAuthor

setSingleValue

addValue

removeValue

getSingleValue

clearValues

setAllowsAdditionalValues

getEntryFieldMask

isAllowsAdditionalValues

setEntryFieldMask

isIntervalInDomain

setIntervalInDomain

isConstrained

setConstrained

getStaticDomainLength

setStaticDomainLength

getPlaceholder

setPlaceholder

setInstanceId

getInstanceId

setRetractTriggered

isRetractTriggered

removeAssignableValue