com.ibm.commerce.catalog.facade.datatypes

Interface AttributePropertyType

    • Method Detail

      • getAttributeIdentifier

        com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType getAttributeIdentifier()
        Returns the value of the 'Attribute Identifier' containment reference. If the attribute is a reference to an attribute from the attribute dictionary, then this element will be populated.
        Returns:
        the value of the 'Attribute Identifier' containment reference.
        See Also:
        setAttributeIdentifier(AttributeIdentifierType), CatalogPackage.getAttributePropertyType_AttributeIdentifier()

      • setAttributeIdentifier

        void setAttributeIdentifier(com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType value)
        Sets the value of the 'Attribute Identifier' containment reference.
        Parameters:
        value - the new value of the 'Attribute Identifier' containment reference.
        See Also:
        getAttributeIdentifier()

      • getParentAttributeGroup

        com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType getParentAttributeGroup()
        Returns the value of the 'Parent Attribute Group' containment reference. The parent attribute group for this attribute.
        Returns:
        the value of the 'Parent Attribute Group' containment reference.
        See Also:
        setParentAttributeGroup(AttributeGroupIdentifierType), CatalogPackage.getAttributePropertyType_ParentAttributeGroup()

      • setParentAttributeGroup

        void setParentAttributeGroup(com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType value)
        Sets the value of the 'Parent Attribute Group' containment reference.
        Parameters:
        value - the new value of the 'Parent Attribute Group' containment reference.
        See Also:
        getParentAttributeGroup()

      • getGroupPath

        java.lang.String getGroupPath()
        Returns the value of the 'Group Path' attribute. The group path of the attribute. It lists all ancestor groups of this attribute separated by "/". For example, if a attribute belongs to Feature group and Feature group belongs to TV group, The group path should be "TV/Feature".
        Returns:
        the value of the 'Group Path' attribute.
        See Also:
        setGroupPath(String), CatalogPackage.getAttributePropertyType_GroupPath()

      • setGroupPath

        void setGroupPath(java.lang.String value)
        Sets the value of the 'Group Path' attribute.
        Parameters:
        value - the new value of the 'Group Path' attribute.
        See Also:
        getGroupPath()

      • getName

        java.lang.String getName()
        Returns the value of the 'Name' attribute. Name of attribute.
        Returns:
        the value of the 'Name' attribute.
        See Also:
        setName(String), CatalogPackage.getAttributePropertyType_Name()

      • setName

        void setName(java.lang.String value)
        Sets the value of the 'Name' attribute.
        Parameters:
        value - the new value of the 'Name' attribute.
        See Also:
        getName()

      • getDescription

        java.lang.String getDescription()
        Returns the value of the 'Description' attribute. Description for the attribute.
        Returns:
        the value of the 'Description' attribute.
        See Also:
        setDescription(String), CatalogPackage.getAttributePropertyType_Description()

      • setDescription

        void setDescription(java.lang.String value)
        Sets the value of the 'Description' attribute.
        Parameters:
        value - the new value of the 'Description' attribute.
        See Also:
        getDescription()

      • getAttributeType

        java.lang.Object getAttributeType()
        Returns the value of the 'Attribute Type' attribute. The attribute type; e.g. attribute with allowed values and attribute with assigned values.
        Returns:
        the value of the 'Attribute Type' attribute.
        See Also:
        setAttributeType(Object), CatalogPackage.getAttributePropertyType_AttributeType()

      • setAttributeType

        void setAttributeType(java.lang.Object value)
        Sets the value of the 'Attribute Type' attribute.
        Parameters:
        value - the new value of the 'Attribute Type' attribute.
        See Also:
        getAttributeType()

      • getAttributeDataType

        java.lang.Object getAttributeDataType()
        Returns the value of the 'Attribute Data Type' attribute. The attribute data type; e.g. String, Integer, Float.
        Returns:
        the value of the 'Attribute Data Type' attribute.
        See Also:
        setAttributeDataType(Object), CatalogPackage.getAttributePropertyType_AttributeDataType()

      • setAttributeDataType

        void setAttributeDataType(java.lang.Object value)
        Sets the value of the 'Attribute Data Type' attribute.
        Parameters:
        value - the new value of the 'Attribute Data Type' attribute.
        See Also:
        getAttributeDataType()

      • getAllowedValue

        java.util.List getAllowedValue()
        Returns the value of the 'Allowed Value' containment reference list. The list contents are of type AttributeAllowedValueType. The allowed values for the attribute. The identifier on the AllowedValue is used when the attribute is being updated for a non-default language. In these cases, the identifier is the site default-language value for the attribute.
        Returns:
        the value of the 'Allowed Value' containment reference list.
        See Also:
        CatalogPackage.getAttributePropertyType_AllowedValue()

      • getStoreDisplay

        java.lang.String getStoreDisplay()
        Returns the value of the 'Store Display' attribute. Value indicating how to display this attribute in an interface. A store interface should use this flag to determine ways to format the display of this attribute.
        Returns:
        the value of the 'Store Display' attribute.
        See Also:
        setStoreDisplay(String), CatalogPackage.getAttributePropertyType_StoreDisplay()

      • setStoreDisplay

        void setStoreDisplay(java.lang.String value)
        Sets the value of the 'Store Display' attribute.
        Parameters:
        value - the new value of the 'Store Display' attribute.
        See Also:
        getStoreDisplay()

      • getFacetProperties

        java.util.Map getFacetProperties()
        Returns the value of the 'Facet Properties' map. The key is of type String, and the value is of type String, Simple name value pairs for defining extended properties for this attribute. Properties that will be stored in this area for a facetable attribute: Property name Property value Default value --------------------------------------------------------------------------------------------- Facet_IncludeInKeyWordSearch 1) "true", stored in form 1) "true" String of String datatype 2) "false", stored in form of String datatype Facet_MultipleSelectio 1) "true" , stored in form 2) "false" String of String datatype 2) "false" , stored in form of String datatype Facet_DisplayZeroCountValues 1) "true" , stored in form 2) "false" String of String datatype 2) "false", stored in form of String datatype Facet_MaxiumumValuesToDisplay 1) An Integer, stored in form Infinity? (-1)? of String datatype Facet_DisplayOrder 1) "Count", stored in form 1) Count (Solr default)
        Returns:
        the value of the 'Facet Properties' map.
        See Also:
        CatalogPackage.getAttributePropertyType_FacetProperties()

      • getExtendedData

        java.util.Map getExtendedData()
        Returns the value of the 'Extended Data' map. The key is of type String, and the value is of type String,
        Returns:
        the value of the 'Extended Data' map.
        See Also:
        CatalogPackage.getAttributePropertyType_ExtendedData()

      • getFolderIdentifier

        java.util.List getFolderIdentifier()
        Returns the value of the 'Folder Identifier' containment reference list. The list contents are of type FolderIdentifierType. The identifier of the folder which this attribute belongs to.
        Returns:
        the value of the 'Folder Identifier' containment reference list.
        See Also:
        CatalogPackage.getAttributePropertyType_FolderIdentifier()

      • getUserData

        UserDataType getUserData()
        Returns the value of the 'User Data' containment reference. User data for the attribute. Can be used for customer extension
        Returns:
        the value of the 'User Data' containment reference.
        See Also:
        setUserData(UserDataType), CatalogPackage.getAttributePropertyType_UserData()

      • setUserData

        void setUserData(UserDataType value)
        Sets the value of the 'User Data' containment reference.
        Parameters:
        value - the new value of the 'User Data' containment reference.
        See Also:
        getUserData()

      • isComparable

        boolean isComparable()
        Returns the value of the 'Comparable' attribute. This flag identifies if this attribute can be used for comparison.
        Returns:
        the value of the 'Comparable' attribute.
        See Also:
        isSetComparable(), unsetComparable(), setComparable(boolean), CatalogPackage.getAttributePropertyType_Comparable()

      • isDisplayable

        boolean isDisplayable()
        Returns the value of the 'Displayable' attribute. This flag identifies if this attribute is displayable at store front.
        Returns:
        the value of the 'Displayable' attribute.
        See Also:
        isSetDisplayable(), unsetDisplayable(), setDisplayable(boolean), CatalogPackage.getAttributePropertyType_Displayable()

      • isFacetable

        boolean isFacetable()
        Returns the value of the 'Facetable' attribute. This flag identifies if this attribute can be used for facetable navigation in the storefront.
        Returns:
        the value of the 'Facetable' attribute.
        See Also:
        isSetFacetable(), unsetFacetable(), setFacetable(boolean), CatalogPackage.getAttributePropertyType_Facetable()

      • getLanguage

        java.lang.String getLanguage()
        Returns the value of the 'Language' attribute. Optional language for the attribute.
        Returns:
        the value of the 'Language' attribute.
        See Also:
        setLanguage(String), CatalogPackage.getAttributePropertyType_Language()

      • setLanguage

        void setLanguage(java.lang.String value)
        Sets the value of the 'Language' attribute.
        Parameters:
        value - the new value of the 'Language' attribute.
        See Also:
        getLanguage()

      • isMerchandisable

        boolean isMerchandisable()
        Returns the value of the 'Merchandisable' attribute. This flag identifies if this attribute can be used for merchandising purpose.
        Returns:
        the value of the 'Merchandisable' attribute.
        See Also:
        isSetMerchandisable(), unsetMerchandisable(), setMerchandisable(boolean), CatalogPackage.getAttributePropertyType_Merchandisable()

      • isSearchable

        boolean isSearchable()
        Returns the value of the 'Searchable' attribute. This flag identifies if this attribute can be used for search.
        Returns:
        the value of the 'Searchable' attribute.
        See Also:
        isSetSearchable(), unsetSearchable(), setSearchable(boolean), CatalogPackage.getAttributePropertyType_Searchable()

      • getUsage

        java.lang.String getUsage()
        Returns the value of the 'Usage' attribute. Use for the attribute.
        Returns:
        the value of the 'Usage' attribute.
        See Also:
        setUsage(String), CatalogPackage.getAttributePropertyType_Usage()

      • setUsage

        void setUsage(java.lang.String value)
        Sets the value of the 'Usage' attribute.
        Parameters:
        value - the new value of the 'Usage' attribute.
        See Also:
        getUsage()
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method