sfcc-dev-mcp 1.0.0

package/docs/dw_suggest/SuggestedCategory.md

@@ -0,0 +1,46 @@
+## Package: dw.suggest
+
+# Class SuggestedCategory
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.SuggestedCategory
+
+## Description
+
+This class represents a suggested catalog category. Use getCategory() method to get access to the actual Category object.
+
+## Properties
+
+### category
+
+**Type:** Category (Read Only)
+
+This method returns the actual Category object corresponding to this suggested category.
+
+## Constructor Summary
+
+## Method Summary
+
+### getCategory
+
+**Signature:** `getCategory() : Category`
+
+This method returns the actual Category object corresponding to this suggested category.
+
+## Method Detail
+
+## Method Details
+
+### getCategory
+
+**Signature:** `getCategory() : Category`
+
+**Description:** This method returns the actual Category object corresponding to this suggested category.
+
+**Returns:**
+
+the category object corresponding to this suggested category
+
+---

package/docs/dw_suggest/SuggestedContent.md

@@ -0,0 +1,46 @@
+## Package: dw.suggest
+
+# Class SuggestedContent
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.SuggestedContent
+
+## Description
+
+This class represents a suggested content page. Use getContent() method to get access to the actual Content object.
+
+## Properties
+
+### content
+
+**Type:** Content (Read Only)
+
+This method returns the actual Content object corresponding to this suggested content.
+
+## Constructor Summary
+
+## Method Summary
+
+### getContent
+
+**Signature:** `getContent() : Content`
+
+This method returns the actual Content object corresponding to this suggested content.
+
+## Method Detail
+
+## Method Details
+
+### getContent
+
+**Signature:** `getContent() : Content`
+
+**Description:** This method returns the actual Content object corresponding to this suggested content.
+
+**Returns:**
+
+the content object corresponding to this suggested content
+
+---

package/docs/dw_suggest/SuggestedPhrase.md

@@ -0,0 +1,70 @@
+## Package: dw.suggest
+
+# Class SuggestedPhrase
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.SuggestedPhrase
+
+## Description
+
+This class represents a suggested phrase. Use getPhrase() method to get access to the phrase.
+
+## Properties
+
+### exactMatch
+
+**Type:** boolean (Read Only)
+
+This method returns a flag signaling whether this phrase is a exact match.
+
+### phrase
+
+**Type:** String (Read Only)
+
+This method returns the actual phrase as a string value.
+
+## Constructor Summary
+
+## Method Summary
+
+### getPhrase
+
+**Signature:** `getPhrase() : String`
+
+This method returns the actual phrase as a string value.
+
+### isExactMatch
+
+**Signature:** `isExactMatch() : boolean`
+
+This method returns a flag signaling whether this phrase is a exact match.
+
+## Method Detail
+
+## Method Details
+
+### getPhrase
+
+**Signature:** `getPhrase() : String`
+
+**Description:** This method returns the actual phrase as a string value.
+
+**Returns:**
+
+the phrase
+
+---
+
+### isExactMatch
+
+**Signature:** `isExactMatch() : boolean`
+
+**Description:** This method returns a flag signaling whether this phrase is a exact match.
+
+**Returns:**
+
+true if this phrase is a exact match, false otherwise
+
+---

package/docs/dw_suggest/SuggestedProduct.md

@@ -0,0 +1,47 @@
+## Package: dw.suggest
+
+# Class SuggestedProduct
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.SuggestedProduct
+
+## Description
+
+This class represents a suggested product. Use getProductSearchHit() method to get access to the actual ProductSearchHit object.
+
+## Properties
+
+### productSearchHit
+
+**Type:** ProductSearchHit (Read Only)
+
+This method returns the actual ProductSearchHit object
+ corresponding to this suggested product.
+
+## Constructor Summary
+
+## Method Summary
+
+### getProductSearchHit
+
+**Signature:** `getProductSearchHit() : ProductSearchHit`
+
+This method returns the actual ProductSearchHit object corresponding to this suggested product.
+
+## Method Detail
+
+## Method Details
+
+### getProductSearchHit
+
+**Signature:** `getProductSearchHit() : ProductSearchHit`
+
+**Description:** This method returns the actual ProductSearchHit object corresponding to this suggested product.
+
+**Returns:**
+
+the product search hit corresponding to this suggested product
+
+---

package/docs/dw_suggest/SuggestedTerm.md

@@ -0,0 +1,143 @@
+## Package: dw.suggest
+
+# Class SuggestedTerm
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.SuggestedTerm
+
+## Description
+
+A single suggested term. Each user input term of the search phrase is being processed separately by the suggestion engine. For each original term, a list of terms will be suggested, either completed terms, corrected terms or even the exact term if it is known to the engine. Each suggested term is represented by a instance of this class. The list of suggested terms belonging to a single original term is represented by a instance of SuggestedTerms class. The suggested term value can either be the completed version of the original term, the corrected version of the original term or exactly the original term.
+
+## Properties
+
+### additional
+
+**Type:** boolean (Read Only)
+
+Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
+
+### completed
+
+**Type:** boolean (Read Only)
+
+Returns whether this suggested term is a auto completed version of the original term.
+ In other words, this method returns true if the original term is a prefix of this suggested term.
+
+### corrected
+
+**Type:** boolean (Read Only)
+
+Returns whether this suggested term is a corrected version of the original term.
+
+### exactMatch
+
+**Type:** boolean (Read Only)
+
+Returns whether this suggested term is exactly matching the original term.
+
+### value
+
+**Type:** String (Read Only)
+
+Returns this suggested term as String value.
+
+## Constructor Summary
+
+## Method Summary
+
+### getValue
+
+**Signature:** `getValue() : String`
+
+Returns this suggested term as String value.
+
+### isAdditional
+
+**Signature:** `isAdditional() : boolean`
+
+Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
+
+### isCompleted
+
+**Signature:** `isCompleted() : boolean`
+
+Returns whether this suggested term is a auto completed version of the original term.
+
+### isCorrected
+
+**Signature:** `isCorrected() : boolean`
+
+Returns whether this suggested term is a corrected version of the original term.
+
+### isExactMatch
+
+**Signature:** `isExactMatch() : boolean`
+
+Returns whether this suggested term is exactly matching the original term.
+
+## Method Detail
+
+## Method Details
+
+### getValue
+
+**Signature:** `getValue() : String`
+
+**Description:** Returns this suggested term as String value.
+
+**Returns:**
+
+the string representation of this suggested term
+
+---
+
+### isAdditional
+
+**Signature:** `isAdditional() : boolean`
+
+**Description:** Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
+
+**Returns:**
+
+true if this suggested term is a additional term, false otherwise
+
+---
+
+### isCompleted
+
+**Signature:** `isCompleted() : boolean`
+
+**Description:** Returns whether this suggested term is a auto completed version of the original term. In other words, this method returns true if the original term is a prefix of this suggested term.
+
+**Returns:**
+
+true if this suggested term is evaluated by auto completion, false otherwise
+
+---
+
+### isCorrected
+
+**Signature:** `isCorrected() : boolean`
+
+**Description:** Returns whether this suggested term is a corrected version of the original term.
+
+**Returns:**
+
+true if this suggested term is a corrected version of the original term, false otherwise
+
+---
+
+### isExactMatch
+
+**Signature:** `isExactMatch() : boolean`
+
+**Description:** Returns whether this suggested term is exactly matching the original term.
+
+**Returns:**
+
+true if this suggested term exactly matches the original term, false otherwise
+
+---

package/docs/dw_suggest/SuggestedTerms.md

@@ -0,0 +1,132 @@
+## Package: dw.suggest
+
+# Class SuggestedTerms
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.SuggestedTerms
+
+## Description
+
+This container represents a list of suggested terms, all belonging to a particular single original term of the users input search phrase. Each user input term of the search phrase is being processed separately by the suggestion engine. For each original term, a list of terms will be suggested, either completed terms, corrected terms or even the exact term if they are known to the engine as they are. A instance of this class refers to the original unmodified term, as well as to a list of SuggestedTerms objects representing a single suggested term.
+
+## Properties
+
+### empty
+
+**Type:** boolean (Read Only)
+
+Returns true if this set of suggested terms is empty.
+
+### firstTerm
+
+**Type:** SuggestedTerm (Read Only)
+
+This method returns the suggested term which is considered best matching
+ with the original term. See getTerms() for a note on ordering of
+ suggested terms.
+
+### originalTerm
+
+**Type:** String (Read Only)
+
+The original term of the user input, for which this instance
+ provides a list of suggested terms. Suggested terms can either be corrected,
+ or completed or exact matching.
+
+### terms
+
+**Type:** Iterator (Read Only)
+
+The list of SuggestedTerms suggested for the original term.
+
+## Constructor Summary
+
+## Method Summary
+
+### getFirstTerm
+
+**Signature:** `getFirstTerm() : SuggestedTerm`
+
+This method returns the suggested term which is considered best matching with the original term.
+
+### getOriginalTerm
+
+**Signature:** `getOriginalTerm() : String`
+
+Returns the original term of the user input, for which this instance provides a list of suggested terms.
+
+### getTerms
+
+**Signature:** `getTerms() : Iterator`
+
+Returns the list of SuggestedTerms suggested for the original term.
+
+### isEmpty
+
+**Signature:** `isEmpty() : boolean`
+
+Returns true if this set of suggested terms is empty.
+
+## Method Detail
+
+## Method Details
+
+### getFirstTerm
+
+**Signature:** `getFirstTerm() : SuggestedTerm`
+
+**Description:** This method returns the suggested term which is considered best matching with the original term. See getTerms() for a note on ordering of suggested terms.
+
+**Returns:**
+
+the best matching term
+
+**See Also:**
+
+getOriginalTerm()
+getTerms()
+
+---
+
+### getOriginalTerm
+
+**Signature:** `getOriginalTerm() : String`
+
+**Description:** Returns the original term of the user input, for which this instance provides a list of suggested terms. Suggested terms can either be corrected, or completed or exact matching.
+
+**Returns:**
+
+the original unmodified term of the user input search phrase
+
+---
+
+### getTerms
+
+**Signature:** `getTerms() : Iterator`
+
+**Description:** Returns the list of SuggestedTerms suggested for the original term.
+
+**Returns:**
+
+a iterator of suggested terms, might be empty
+
+**See Also:**
+
+getOriginalTerm()
+isEmpty()
+
+---
+
+### isEmpty
+
+**Signature:** `isEmpty() : boolean`
+
+**Description:** Returns true if this set of suggested terms is empty.
+
+**Returns:**
+
+true if no suggested term is contained in this set, false otherwise
+
+---

package/docs/dw_suggest/Suggestions.md

@@ -0,0 +1,179 @@
+## Package: dw.suggest
+
+# Class Suggestions
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.suggest.Suggestions
+
+## Description
+
+This is the base class for suggestions containers. For each type of items, a sub class provides methods to access the actual items. See the sub classes for more specific information.
+
+## Properties
+
+### searchPhraseSuggestions
+
+**Type:** SearchPhraseSuggestions (Read Only)
+
+The suggested search phrases that are associated to this suggestions.
+ 
+ In contrast to the suggested items, the suggested phrases contains the corrected and
+ completed versions of the original search phrase.
+
+### suggestedPhrases
+
+**Type:** Iterator (Read Only)
+
+A list of SuggestedPhrase objects that relates to the
+ user input search phrase.
+
+### suggestedTerms
+
+**Type:** Iterator (Read Only)
+
+A list of SuggestedTerms objects. Each of the returned
+ instances represents a set of terms suggested for a particular single term
+ of the user input search phrase.
+
+## Constructor Summary
+
+## Method Summary
+
+### getSearchPhraseSuggestions
+
+**Signature:** `getSearchPhraseSuggestions() : SearchPhraseSuggestions`
+
+Returns the suggested search phrases that are associated to this suggestions.
+
+### getSuggestedPhrases
+
+**Signature:** `getSuggestedPhrases() : Iterator`
+
+Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
+
+### getSuggestedTerms
+
+**Signature:** `getSuggestedTerms() : Iterator`
+
+Returns a list of SuggestedTerms objects.
+
+### hasSuggestedPhrases
+
+**Signature:** `hasSuggestedPhrases() : boolean`
+
+Returns whether this suggestions container has any suggested phrases.
+
+### hasSuggestedTerms
+
+**Signature:** `hasSuggestedTerms() : boolean`
+
+Returns whether this suggestions container has any suggested terms.
+
+### hasSuggestions
+
+**Signature:** `hasSuggestions() : boolean`
+
+Returns whether this suggestions container has any suggested items, i.e.
+
+## Method Detail
+
+## Method Details
+
+### getSearchPhraseSuggestions
+
+**Signature:** `getSearchPhraseSuggestions() : SearchPhraseSuggestions`
+
+**Description:** Returns the suggested search phrases that are associated to this suggestions. In contrast to the suggested items, the suggested phrases contains the corrected and completed versions of the original search phrase.
+
+**Returns:**
+
+the suggested search phrases for this suggestions
+
+---
+
+### getSuggestedPhrases
+
+**Signature:** `getSuggestedPhrases() : Iterator`
+
+**Description:** Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
+
+**Deprecated:**
+
+Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
+
+**Returns:**
+
+a list of SuggestedPhrases
+
+**See Also:**
+
+hasSuggestedPhrases()
+
+---
+
+### getSuggestedTerms
+
+**Signature:** `getSuggestedTerms() : Iterator`
+
+**Description:** Returns a list of SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.
+
+**Deprecated:**
+
+Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
+
+**Returns:**
+
+a list of SuggestedTerms for each term of the user input search phrase
+
+---
+
+### hasSuggestedPhrases
+
+**Signature:** `hasSuggestedPhrases() : boolean`
+
+**Description:** Returns whether this suggestions container has any suggested phrases. Note that this method only looks for suggested phrases. It does not account for suggested terms or suggested objects. In other words, even if there are suggested terms or objects, this method will return false if this suggestions container has no phrases.
+
+**Deprecated:**
+
+Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
+
+**Returns:**
+
+true only if there are phrases available
+
+---
+
+### hasSuggestedTerms
+
+**Signature:** `hasSuggestedTerms() : boolean`
+
+**Description:** Returns whether this suggestions container has any suggested terms. Note that this method checks suggested terms only, but not suggested phrases or suggested objects.
+
+**Deprecated:**
+
+Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
+
+**Returns:**
+
+true only if there are terms available
+
+---
+
+### hasSuggestions
+
+**Signature:** `hasSuggestions() : boolean`
+
+**Description:** Returns whether this suggestions container has any suggested items, i.e. products. Note that this method only looks for concrete suggested items. It does not account for suggested terms. In other words, even if there are suggested terms, this method will return false if no matching items, like products or categories, were found for the suggested terms. To find out whether there are suggested terms and how they match with respect to the original search phrase, one can use getSuggestedTerms() to obtain a list of SuggestedTerms.
+
+**Returns:**
+
+true only if there are items found using the suggested terms
+
+**See Also:**
+
+getSuggestedTerms()
+SuggestedTerms.isEmpty()
+
+---