ItemInspect (ATG Java API)

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

All Implemented Interfaces:: java.io.Serializable

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

An item's details in an inspection

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

ItemInspect()

Constructors
Constructor and Description
`ItemInspect()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object pObject)`
`protected static ItemInspect`	`fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)`
`protected void`	`getAttributeXML(java.lang.StringBuilder sb)`
`protected void`	`getBodyXML(java.lang.StringBuilder sb)`
`java.util.List<java.lang.String>`	`getCollections()` Returns the list of collections of an item
`java.lang.String`	`getDocset()` Returns the physical document set of item
`atg.search.routing.command.search.DocumentFormat`	`getFormat()` Returns document format of item
`int`	`getId()` Returns the item's id
`atg.search.routing.utils.Language`	`getLanguage()` Returns language of item
`ItemTrace`	`getLinkedItemTrace()` This is not part of the xml.
`java.util.List<java.lang.String>`	`getMetaIdxs()` Returns the Indexed meta properties
`java.util.List<java.lang.String>`	`getMetaSets()` Returns the list of meta-data document sets of item
`java.util.HashMap<java.lang.String,java.util.List<ItemProperty>>`	`getProperties()` Returns a Map of Lists of indexed meta properties
`java.lang.String`	`getRequestTag()` Gets the xml element tag used in the request
`java.util.Map<java.lang.String,java.util.List<Sentence>>`	`getSentenceMap()` Returns map of indexed sentences, where the map key is the sentence field
`java.util.List<Sentence>`	`getSentences()` Returns the List of indexed sentences
`java.lang.String`	`getSummary()` Returns item's summary
`java.lang.String`	`getTitle()` Returns item's title
`java.util.List<java.lang.String>`	`getTopicSets()` Returns the list of topic document sets of an item
`java.lang.String`	`getTrackId()` Returns the item's external "tracked" ID, from UI, probably the repository ID of a product or SKU
`ItemType`	`getType()` Returns item's type
`java.lang.String`	`getUrl()` Returns item's url
`int`	`hashCode()`
`void`	`setCollections(java.util.List<java.lang.String> pCollections)` Sets collections of an item
`void`	`setDocset(java.lang.String pDocset)` Sets physical document set of item
`void`	`setFormat(atg.search.routing.command.search.DocumentFormat pFormat)` Sets document format of item
`void`	`setId(int pId)` Sets item's id
`void`	`setLanguage(atg.search.routing.utils.Language pLanguage)` Sets language of item
`void`	`setLinkedItemTrace(ItemTrace pLinkedItemTrace)` Sets the linked item trace
`void`	`setMetaIdxs(java.util.List<java.lang.String> pMetaIdxs)` Sets Indexed meta properties
`void`	`setMetaSets(java.util.List<java.lang.String> pMetaSets)` Sets meta-data document sets of item
`void`	`setProperties(java.util.HashMap<java.lang.String,java.util.List<ItemProperty>> pProperties)` Sets Map of Lists of indexed meta properties
`void`	`setSentenceMap(java.util.Map<java.lang.String,java.util.List<Sentence>> pSentenceMap)` Sets map of indexed sentences, where the map key is the sentence field
`void`	`setSentences(java.util.List<Sentence> pSentences)` Sets List of indexed sentences
`void`	`setSummary(java.lang.String pSummary)` Sets item's summary
`void`	`setTitle(java.lang.String pTitle)` Sets item's title
`void`	`setTopicSets(java.util.List<java.lang.String> pTopicSets)` Sets topic document sets of an item
`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`	`setType(ItemType pType)` Sets item's type
`void`	`setUrl(java.lang.String pUrl)` Sets 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
  - ItemInspect
```
public ItemInspect()
```
- 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
  - getSentenceMap
```
public java.util.Map<java.lang.String,java.util.List<Sentence>> getSentenceMap()
```
    Returns map of indexed sentences, where the map key is the sentence field
    
    Returns:
    
    map of indexed sentences, where the map key is the sentence field.
    
    See Also:
    
    Sentence.getField()
  - setSentenceMap
```
public void setSentenceMap(java.util.Map<java.lang.String,java.util.List<Sentence>> pSentenceMap)
```
    Sets map of indexed sentences, where the map key is the sentence field
    
    Parameters:
    
    pSentenceMap - map of indexed sentences, where the map key is the sentence field
    
    See Also:
    
    Sentence.getField()
  - getSentences
```
public java.util.List<Sentence> getSentences()
```
    Returns the List of indexed sentences
    
    Returns:
    
    List of indexed sentences
    
    See Also:
    
    getSentenceMap()
  - setSentences
```
public void setSentences(java.util.List<Sentence> pSentences)
```
    Sets List of indexed sentences
    
    Parameters:
    
    pSentences - List of indexed sentences
    
    See Also:
    
    setSentenceMap(java.util.Map)
  - getLinkedItemTrace
```
public ItemTrace getLinkedItemTrace()
```
    This is not part of the xml. This is calculated after the item traces and inspects have been parsed. See ItemTrace.getLinkedItemInspect()
    
    Returns:
    
    linked item trace, or null if there isn't one
  - setLinkedItemTrace
```
public void setLinkedItemTrace(ItemTrace pLinkedItemTrace)
```
    Sets the linked item trace
    
    Parameters:
    
    pLinkedItemTrace -
  - getProperties
```
public java.util.HashMap<java.lang.String,java.util.List<ItemProperty>> getProperties()
```
    Returns a Map of Lists of indexed meta properties
    
    Returns:
    
    Map of Lists of indexed meta properties
  - setProperties
```
public void setProperties(java.util.HashMap<java.lang.String,java.util.List<ItemProperty>> pProperties)
```
    Sets Map of Lists of indexed meta properties
    
    Parameters:
    
    pProperties -
  - getMetaIdxs
```
public java.util.List<java.lang.String> getMetaIdxs()
```
    Returns the Indexed meta properties
    
    Returns:
    
    Indexed meta properties
  - setMetaIdxs
```
public void setMetaIdxs(java.util.List<java.lang.String> pMetaIdxs)
```
    Sets Indexed meta properties
    
    Parameters:
    
    pMetaIdxs -
  - getTopicSets
```
public java.util.List<java.lang.String> getTopicSets()
```
    Returns the list of topic document sets of an item
    
    Returns:
    
    topic document sets of an item
  - getCollections
```
public java.util.List<java.lang.String> getCollections()
```
    Returns the list of collections of an item
    
    Returns:
    
    collections of an item
  - setTopicSets
```
public void setTopicSets(java.util.List<java.lang.String> pTopicSets)
```
    Sets topic document sets of an item
    
    Parameters:
    
    pTopicSets -
  - setCollections
```
public void setCollections(java.util.List<java.lang.String> pCollections)
```
    Sets collections of an item
    
    Parameters:
    
    pCollections -
  - getMetaSets
```
public java.util.List<java.lang.String> getMetaSets()
```
    Returns the list of meta-data document sets of item
    
    Returns:
    
    meta-data document sets of item
  - setMetaSets
```
public void setMetaSets(java.util.List<java.lang.String> pMetaSets)
```
    Sets meta-data document sets of item
    
    Parameters:
    
    pMetaSets -
  - getId
```
public int getId()
```
    Returns the item's id
    
    Returns:
    
    item's id
  - setId
```
public void setId(int pId)
```
    Sets item's id
    
    Parameters:
    
    pId -
  - getUrl
```
public java.lang.String getUrl()
```
    Returns item's url
    
    Returns:
    
    item's url
  - setUrl
```
public void setUrl(java.lang.String pUrl)
```
    Sets item's url
    
    Parameters:
    
    pUrl -
  - getTitle
```
public java.lang.String getTitle()
```
    Returns item's title
    
    Returns:
    
    item's title
  - setTitle
```
public void setTitle(java.lang.String pTitle)
```
    Sets item's title
    
    Parameters:
    
    pTitle -
  - getSummary
```
public java.lang.String getSummary()
```
    Returns item's summary
    
    Returns:
    
    item's summary
  - setSummary
```
public void setSummary(java.lang.String pSummary)
```
    Sets item's summary
    
    Parameters:
    
    pSummary -
  - getType
```
public ItemType getType()
```
    Returns item's type
    
    Returns:
    
    item's type
  - setType
```
public void setType(ItemType pType)
```
    Sets item's type
    
    Parameters:
    
    pType -
  - getDocset
```
public java.lang.String getDocset()
```
    Returns the physical document set of item
    
    Returns:
    
    physical document set of item
  - setDocset
```
public void setDocset(java.lang.String pDocset)
```
    Sets physical document set of item
    
    Parameters:
    
    pDocset -
  - getFormat
```
public atg.search.routing.command.search.DocumentFormat getFormat()
```
    Returns document format of item
    
    Returns:
    
    document format of item
  - setFormat
```
public void setFormat(atg.search.routing.command.search.DocumentFormat pFormat)
```
    Sets document format of item
    
    Parameters:
    
    pFormat -
  - getLanguage
```
public atg.search.routing.utils.Language getLanguage()
```
    Returns language of item
    
    Returns:
    
    language of item
  - setLanguage
```
public void setLanguage(atg.search.routing.utils.Language pLanguage)
```
    Sets language of item
    
    Parameters:
    
    pLanguage -
  - 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 -
  - fromXmlParser
```
protected static ItemInspect fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)
```
  - 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 ItemInspect

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

ItemInspect

Method Detail

equals

hashCode

getSentenceMap

setSentenceMap

getSentences

setSentences

getLinkedItemTrace

setLinkedItemTrace

getProperties

setProperties

getMetaIdxs

setMetaIdxs

getTopicSets

getCollections

setTopicSets

setCollections

getMetaSets

setMetaSets

getId

setId

getUrl

setUrl

getTitle

setTitle

getSummary

setSummary

getType

setType

getDocset

setDocset

getFormat

setFormat

getLanguage

setLanguage

getTrackId

setTrackId

fromXmlParser

getRequestTag

getAttributeXML

getBodyXML