Package de.hybris.platform.sap.productconfig.runtime.interf.model

Interface CsticModel

  • All Superinterfaces:
    BaseModel, java.lang.Cloneable
    All Known Implementing Classes:
    CsticModelImpl
    public interface CsticModel
extends BaseModel
    Represents the characteristic model.

    • Field Detail

      • TYPE_CLASS

        static final int TYPE_CLASS
        Value type for object class (materials)
        See Also:
        Constant Field Values

      • AUTHOR_SYSTEM

        static final java.lang.String AUTHOR_SYSTEM
        Indicating that the value of this cstic was automatically assigned by the configuration engine.
        See Also:
        Constant Field Values

      • AUTHOR_USER

        static final java.lang.String AUTHOR_USER
        Indicating that the value of this cstic was assigned by the user.
        See Also:
        Constant Field Values

      • AUTHOR_DEFAULT

        static final java.lang.String AUTHOR_DEFAULT
        Indicating that the value of this cstic was defaulted by the system.
        See Also:
        Constant Field Values

      • AUTHOR_NOAUTHOR

        static final java.lang.String AUTHOR_NOAUTHOR
        Indicating that there is no author information available
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        java.lang.String getName()
        Returns:
        the characteristic name

      • setName

        void setName​(java.lang.String name)
        Parameters:
        name - characteristic name

      • getLanguageDependentName

        java.lang.String getLanguageDependentName()
        Returns:
        the characteristic language dependent name

      • setLanguageDependentName

        void setLanguageDependentName​(java.lang.String languageDependentName)
        Parameters:
        languageDependentName - characteristic language dependent name

      • getLongText

        java.lang.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​(java.lang.String longText)
        Set the long text, which will be displayed under the Cstic name in the UI
        Parameters:
        longText - Description for the cstic

      • getAssignedValues

        java.util.List<CsticValueModel> getAssignedValues()
        Returns:
        an unmodifiable list of all assigned values

      • setAssignedValuesWithoutCheckForChange

        void setAssignedValuesWithoutCheckForChange​(java.util.List<CsticValueModel> assignedValues)
        sets assigned value without to check whether the characteristic was changed
        Parameters:
        assignedValues - list of all assigned values

      • setAssignedValues

        void setAssignedValues​(java.util.List<CsticValueModel> assignedValues)
        Parameters:
        assignedValues - list of all assigned values

      • getAssignableValues

        java.util.List<CsticValueModel> getAssignableValues()
        Returns:
        an unmodifiable list of all assignable values

      • setAssignableValues

        void setAssignableValues​(java.util.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

      • getAuthor

        java.lang.String getAuthor()
        Returns:
        the characteristic author

      • setAuthor

        void setAuthor​(java.lang.String author)
        Parameters:
        author - haracteristic author

      • setSingleValue

        void setSingleValue​(java.lang.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​(java.lang.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​(java.lang.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

        java.lang.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

        java.lang.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​(java.lang.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. This means for us: It carries a static domain (at runtime this domain might be gone due to restrictable characteristics!), and no additional values are allowed

      • setConstrained

        void setConstrained​(boolean constrained)
        Parameters:
        constrained - Flag indicating whether the characteristic is constrained. This means for us: It carries a static domain (at runtime this domain might be gone due to restrictable characteristics!), and no additional values are allowed

      • 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

        java.lang.String getPlaceholder()
        Returns:
        the place holder for input field

      • setPlaceholder

        void setPlaceholder​(java.lang.String placeHolder)
        Parameters:
        placeHolder - place holder for input field

      • setInstanceId

        void setInstanceId​(java.lang.String instanceId)
        Parameters:
        instanceId - ID of corresponding instance. See InstanceModel.getId()

      • getInstanceId

        java.lang.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​(java.lang.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

      • getMessages

        default java.util.Set<ProductConfigMessage> getMessages()
        Returns:
        messages valid for this characteristic

      • setMessages

        default void setMessages​(java.util.Set<ProductConfigMessage> messages)
        Parameters:
        messages - valid for this characteristic

      • setInstanceName

        void setInstanceName​(java.lang.String instanceName)
        Sets name of hosting instance. This can be a product key or a class identifier
        Parameters:
        instanceName -

      • getInstanceName

        java.lang.String getInstanceName()
        Returns:
        Name of hosting instance. This can be a product key or a class identifier