atg.repository.search.indexing.config

Class SearchUpdateCustomizationItem

java.lang.Object

atg.repository.search.indexing.config.SearchUpdateCustomizationItem

All Implemented Interfaces:

atg.repository.search.indexing.config.SearchUpdateXMLHandler, atg.search.adapter.customization.CustomizationItem

public class SearchUpdateCustomizationItem
extends java.lang.Object
implements atg.search.adapter.customization.CustomizationItem, atg.repository.search.indexing.config.SearchUpdateXMLHandler

This class implements the search customization item interface to hold the search update data for the search engine.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SearchUpdateCustomizationItem(SearchUpdateAdapter pAdapter, java.lang.String pId)

Method Summary

Methods

Modifier and Type	Method and Description
atg.search.adapter.loader.AcquireSessionStatus	acquireCustomizations(atg.search.adapter.loader.AcquireSession pSession) Acquire customizations.
SearchUpdateAdapter	getAdapter() Get SearchUpdateAdapter reference.
atg.search.adapter.customization.CustomizationType	getCustomizationType() Get the customization type.
java.lang.String	getDisplayName() Get the display name
java.lang.String	getId() Get the Id.
long	getTimestamp() Get the last modified timestamp.
void	handleSearchUpdateXML(java.lang.String pSearchUpdateXMLString) implement the SearchUpdateXMLHandler interface
void	setAdapter(SearchUpdateAdapter pAdapter) Set SearchUpdateAdapter reference.
void	setDisplayName(java.lang.String pDisplayName) Set the display name
void	setId(java.lang.String pId) Set the Id
void	setTimestamp(long pTimestamp) Set the last modified timestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

SearchUpdateCustomizationItem

public SearchUpdateCustomizationItem(SearchUpdateAdapter pAdapter,
                             java.lang.String pId)

Method Detail

getAdapter

public SearchUpdateAdapter getAdapter()

Get SearchUpdateAdapter reference.

setAdapter

public void setAdapter(SearchUpdateAdapter pAdapter)

Set SearchUpdateAdapter reference.

getId

public java.lang.String getId()

Get the Id.

Specified by:

getId in interface atg.search.adapter.customization.CustomizationItem

setId

public void setId(java.lang.String pId)

Set the Id

getDisplayName

public java.lang.String getDisplayName()

Get the display name

Specified by:

getDisplayName in interface atg.search.adapter.customization.CustomizationItem

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Set the display name

getCustomizationType

public atg.search.adapter.customization.CustomizationType getCustomizationType()

Get the customization type.

Specified by:

getCustomizationType in interface atg.search.adapter.customization.CustomizationItem

getTimestamp

public long getTimestamp()

Get the last modified timestamp.

Specified by:

getTimestamp in interface atg.search.adapter.customization.CustomizationItem

setTimestamp

public void setTimestamp(long pTimestamp)

Set the last modified timestamp

acquireCustomizations

public atg.search.adapter.loader.AcquireSessionStatus acquireCustomizations(atg.search.adapter.loader.AcquireSession pSession)
                                                                     throws atg.search.adapter.exception.AdapterException

Acquire customizations. Customization commands should be sent to to the session via processCommand. Unlike a ContentItemAdapter, this method should NOT spawn a new thread, and should only return when it is done sending commands.

Specified by:

acquireCustomizations in interface atg.search.adapter.customization.CustomizationItem

Parameters:

pSession - the session for the customization acquisition.

Throws:

atg.search.adapter.exception.AdapterException

handleSearchUpdateXML

public void handleSearchUpdateXML(java.lang.String pSearchUpdateXMLString)

implement the SearchUpdateXMLHandler interface

Specified by:

handleSearchUpdateXML in interface atg.repository.search.indexing.config.SearchUpdateXMLHandler

Parameters:

pSearchUpdateXMLString -