com.ibm.commerce.search.facade.datatypes

Interface SearchTermAssociationType

    • Method Detail

      • getUniqueID

        java.lang.String getUniqueID()
        Returns the value of the 'Unique ID' attribute. The SearchTermAssociation identifier.
        Returns:
        the value of the 'Unique ID' attribute.
        See Also:
        setUniqueID(String), SearchPackage.getSearchTermAssociationType_UniqueID()
      • setUniqueID

        void setUniqueID(java.lang.String value)
        Sets the value of the 'Unique ID' attribute.
        Parameters:
        value - the new value of the 'Unique ID' attribute.
        See Also:
        getUniqueID()
      • getSearchTerms

        java.lang.String getSearchTerms()
        Returns the value of the 'Search Terms' attribute. A comma delimited list of terms that can be specified by a person performing a search. For a synonym association type, multiple search terms are expected. For the replacement association types, a single search term is expected.
        Returns:
        the value of the 'Search Terms' attribute.
        See Also:
        setSearchTerms(String), SearchPackage.getSearchTermAssociationType_SearchTerms()
      • setSearchTerms

        void setSearchTerms(java.lang.String value)
        Sets the value of the 'Search Terms' attribute.
        Parameters:
        value - the new value of the 'Search Terms' attribute.
        See Also:
        getSearchTerms()
      • getAssociationType

        java.lang.Object getAssociationType()
        Returns the value of the 'Association Type' attribute. The type of association between a search term and the associated terms. The valid values are: Synonym: All the search terms are used when searching for any of the search terms. In this case, the AssociatedTerms element is empty. SearchForInstead: A replacement association where the associated terms are searched for instead of the input search term. AlsoSearchFor: A replacement association where the associated terms are used along with the the input search term.
        Returns:
        the value of the 'Association Type' attribute.
        See Also:
        setAssociationType(Object), SearchPackage.getSearchTermAssociationType_AssociationType()
      • setAssociationType

        void setAssociationType(java.lang.Object value)
        Sets the value of the 'Association Type' attribute.
        Parameters:
        value - the new value of the 'Association Type' attribute.
        See Also:
        getAssociationType()
      • getAssociatedTerms

        java.lang.String getAssociatedTerms()
        Returns the value of the 'Associated Terms' attribute. A comma delimited list of words used by the search engine instead of the search terms when performing a search. When no associated terms are defined, it implies that the search terms are all equivalent.
        Returns:
        the value of the 'Associated Terms' attribute.
        See Also:
        setAssociatedTerms(String), SearchPackage.getSearchTermAssociationType_AssociatedTerms()
      • setAssociatedTerms

        void setAssociatedTerms(java.lang.String value)
        Sets the value of the 'Associated Terms' attribute.
        Parameters:
        value - the new value of the 'Associated Terms' attribute.
        See Also:
        getAssociatedTerms()
      • getStoreIdentifier

        StoreIdentifierType getStoreIdentifier()
        Returns the value of the 'Store Identifier' containment reference. The identifier of the store associated with the catalog group.
        Returns:
        the value of the 'Store Identifier' containment reference.
        See Also:
        setStoreIdentifier(StoreIdentifierType), SearchPackage.getSearchTermAssociationType_StoreIdentifier()
      • getLanguageIdentifier

        java.lang.String getLanguageIdentifier()
        Returns the value of the 'Language Identifier' attribute. The identifier of the store associated with the catalog group.
        Returns:
        the value of the 'Language Identifier' attribute.
        See Also:
        setLanguageIdentifier(String), SearchPackage.getSearchTermAssociationType_LanguageIdentifier()
      • setLanguageIdentifier

        void setLanguageIdentifier(java.lang.String value)
        Sets the value of the 'Language Identifier' attribute.
        Parameters:
        value - the new value of the 'Language Identifier' attribute.
        See Also:
        getLanguageIdentifier()
      • getStatistics

        com.ibm.commerce.search.facade.datatypes.StatisticsType getStatistics()
        Returns the value of the 'Statistics' containment reference. The types for STA statistics. The valid values are: TopHits: Keyword top hits statistics for user sessions. TopMisses: Keyword top misses statistics for user sessions.
        Returns:
        the value of the 'Statistics' containment reference.
        See Also:
        setStatistics(StatisticsType), SearchPackage.getSearchTermAssociationType_Statistics()
      • setStatistics

        void setStatistics(com.ibm.commerce.search.facade.datatypes.StatisticsType value)
        Sets the value of the 'Statistics' containment reference.
        Parameters:
        value - the new value of the 'Statistics' containment reference.
        See Also:
        getStatistics()
      • getUserData

        UserDataType getUserData()
        Returns the value of the 'User Data' containment reference. The user data area.
        Returns:
        the value of the 'User Data' containment reference.
        See Also:
        setUserData(UserDataType), SearchPackage.getSearchTermAssociationType_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()