ItemTrace (ATG Java API)

java.lang.Object
- atg.search.routing.command.SearchXMLObject
- - atg.search.routing.command.search.ItemTrace

All Implemented Interfaces:: java.io.Serializable

public class ItemTrace
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Search trace for an item

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string

Constructor Summary

Constructors
Constructor and Description

ItemTrace()

Constructors
Constructor and Description
`ItemTrace()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object pObject)`
`protected static ItemTrace`	`fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)`
`protected void`	`getAttributeXML(java.lang.StringBuilder sb)`
`protected void`	`getBodyXML(java.lang.StringBuilder sb)`
`ConstraintDiagnostics`	`getConstraints()` Step 0: Returns the series of constraints that were applied during search
`int`	`getId()` Returns the item's identifier
`ItemRetrieval`	`getItemRetrieval()` Step 1: Returns the term look up of items, plus application of boolean logic and other limits
`java.lang.String`	`getLanguage()` Returns the language restriction.
`ItemInspect`	`getLinkedItemInspect()` This is not from the xml.
`float`	`getRelevance()` Returns the final relevance of the item
`Relevancy`	`getRelevancy()` Step 3: Returns the calculation of relevancy and application of the threshold
`java.lang.String`	`getRequestTag()` Gets the xml element tag used in the request
`ResultCollection`	`getResultCollection()` Step 4: Returns the result collection and grouping
`StatementRetrieval`	`getStatementRetrieval()` Step 2: Returns the term look up of statements, plus application of boolean logic and other limits
`ItemSummary`	`getSummary()` Returns the summary status of search phases
`java.lang.String`	`getTrackId()` Returns the item's external "tracked" ID, from UI, probably the repository ID of a product or SKU
`java.lang.String`	`getUrl()` Returns the item's url
`int`	`hashCode()`
`void`	`setConstraints(ConstraintDiagnostics pConstraints)` Step 0: Series of constraints that were applied during search
`void`	`setId(int pId)` Sets item's identifier
`void`	`setItemRetrieval(ItemRetrieval pItemRetrieval)` Step 1: Term look up of items, plus application of boolean logic and other limits
`void`	`setLanguage(java.lang.String pLanguage)` Sets the language restriction
`void`	`setLinkedItemInspect(ItemInspect pLinkedItemInspect)` Sets the linked item inspect
`void`	`setRelevance(float pRelevance)` Sets the relevance
`void`	`setRelevancy(Relevancy pRelevancy)` Step 3: Calculation of relevancy and application of the threshold
`void`	`setResultCollection(ResultCollection pResultCollection)` Step 4: Result collection and grouping
`void`	`setStatementRetrieval(StatementRetrieval pStatementRetrieval)` Step 2: Term look up of statements, plus application of boolean logic and other limits
`void`	`setSummary(ItemSummary pSummary)` Sets the summary status of search phases
`void`	`setTrackId(java.lang.String pTrackId)` Sets the item's external "tracked" ID, from UI, probably the repository ID of a product or SKU
`void`	`setUrl(java.lang.String pUrl)` Sets the item's url

Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
- Constructor Detail
  - ItemTrace
```
public ItemTrace()
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object pObject)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public int getId()
```
    Returns the item's identifier
    
    Returns:
    
    item's identifier
  - setId
```
public void setId(int pId)
```
    Sets item's identifier
    
    Parameters:
    
    pId -
  - getLinkedItemInspect
```
public ItemInspect getLinkedItemInspect()
```
    This is not from the xml. It is set after the inspects and traces have been parsed. See ItemInspect.getLinkedItemTrace().
    
    Returns:
    
    linked item inspect, or null if there isn't one
  - setLinkedItemInspect
```
public void setLinkedItemInspect(ItemInspect pLinkedItemInspect)
```
    Sets the linked item inspect
    
    Parameters:
    
    pLinkedItemInspect -
  - getUrl
```
public java.lang.String getUrl()
```
    Returns the item's url
    
    Returns:
    
    item's url
  - setUrl
```
public void setUrl(java.lang.String pUrl)
```
    Sets the item's url
    
    Parameters:
    
    pUrl -
  - getTrackId
```
public java.lang.String getTrackId()
```
    Returns the item's external "tracked" ID, from UI, probably the repository ID of a product or SKU
    
    Returns:
    
    Item's external "tracked" ID, from UI, probably the repository ID of a product or SKU
  - setTrackId
```
public void setTrackId(java.lang.String pTrackId)
```
    Sets the item's external "tracked" ID, from UI, probably the repository ID of a product or SKU
    
    Parameters:
    
    pTrackId -
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns the language restriction. The language could be a language display name (english) or a language code (en_us)
    
    Returns:
    
    Language restriction of the trace expression, if any
  - setLanguage
```
public void setLanguage(java.lang.String pLanguage)
```
    Sets the language restriction
    
    Parameters:
    
    pLanguage -
  - getSummary
```
public ItemSummary getSummary()
```
    Returns the summary status of search phases
    
    Returns:
    
    Summary status of search phases
  - setSummary
```
public void setSummary(ItemSummary pSummary)
```
    Sets the summary status of search phases
    
    Parameters:
    
    pSummary -
  - getConstraints
```
public ConstraintDiagnostics getConstraints()
```
    Step 0: Returns the series of constraints that were applied during search
    
    Returns:
    
    Step 0: Series of constraints that were applied during search
  - setConstraints
```
public void setConstraints(ConstraintDiagnostics pConstraints)
```
    Step 0: Series of constraints that were applied during search
    
    Parameters:
    
    pConstraints -
  - getItemRetrieval
```
public ItemRetrieval getItemRetrieval()
```
    Step 1: Returns the term look up of items, plus application of boolean logic and other limits
    
    Returns:
    
    Step 1: Term look up of items, plus application of boolean logic and other limits
  - setItemRetrieval
```
public void setItemRetrieval(ItemRetrieval pItemRetrieval)
```
    Step 1: Term look up of items, plus application of boolean logic and other limits
    
    Parameters:
    
    pItemRetrieval -
  - getStatementRetrieval
```
public StatementRetrieval getStatementRetrieval()
```
    Step 2: Returns the term look up of statements, plus application of boolean logic and other limits
    
    Returns:
    
    Step 2: Term look up of statements, plus application of boolean logic and other limits
  - setStatementRetrieval
```
public void setStatementRetrieval(StatementRetrieval pStatementRetrieval)
```
    Step 2: Term look up of statements, plus application of boolean logic and other limits
    
    Parameters:
    
    pStatementRetrieval -
  - getRelevancy
```
public Relevancy getRelevancy()
```
    Step 3: Returns the calculation of relevancy and application of the threshold
    
    Returns:
    
    Step 3: Calculation of relevancy and application of the threshold
  - setRelevancy
```
public void setRelevancy(Relevancy pRelevancy)
```
    Step 3: Calculation of relevancy and application of the threshold
    
    Parameters:
    
    pRelevancy -
  - getResultCollection
```
public ResultCollection getResultCollection()
```
    Step 4: Returns the result collection and grouping
    
    Returns:
    
    Step 4: Result collection and grouping
  - setResultCollection
```
public void setResultCollection(ResultCollection pResultCollection)
```
    Step 4: Result collection and grouping
    
    Parameters:
    
    pResultCollection -
  - fromXmlParser
```
protected static ItemTrace fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
```
  - setRelevance
```
public void setRelevance(float pRelevance)
```
    Sets the relevance
    
    Parameters:
    
    pRelevance -
  - getRelevance
```
public float getRelevance()
```
    Returns the final relevance of the item
    
    Returns:
    
    Final relevance of the item
  - getRequestTag
```
public java.lang.String getRequestTag()
```
    Gets the xml element tag used in the request
    
    Specified by:
    
    getRequestTag in class atg.search.routing.command.SearchXMLObject
    
    Returns:
    
    xml element tag
  - getAttributeXML
```
protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException
```
    Overrides:
    
    getAttributeXML in class atg.search.routing.command.SearchXMLObject
    
    Throws:
    
    atg.search.routing.command.IncompleteCommandException
  - getBodyXML
```
protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException
```
    Overrides:
    
    getBodyXML in class atg.search.routing.command.SearchXMLObject
    
    Throws:
    
    atg.search.routing.command.IncompleteCommandException

Class ItemTrace

Field Summary

Constructor Summary

Method Summary

Methods inherited from class atg.search.routing.command.SearchXMLObject

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

Constructor Detail

ItemTrace

Method Detail

equals

hashCode

getId

setId

getLinkedItemInspect

setLinkedItemInspect

getUrl

setUrl

getTrackId

setTrackId

getLanguage

setLanguage

getSummary

setSummary

getConstraints

setConstraints

getItemRetrieval

setItemRetrieval

getStatementRetrieval

setStatementRetrieval

getRelevancy

setRelevancy

getResultCollection

setResultCollection

fromXmlParser

setRelevance

getRelevance

getRequestTag

getAttributeXML

getBodyXML