com.sapportals.wcm.service.indexmanagement.retrieval.classification

Class UpdateTaxonomyState

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.retrieval.classification.UpdateTaxonomyState

public final class UpdateTaxonomyState

extends Object

Describes the actual state of a query based taxonomy with respect to its update state.

Field Summary

static String	ACTIVE_UPDATE
static String	END_UPDATE
static String	FAILED_UPDATE
static String	NO_INFO_UPDATE
static String	NO_UPDATE
static String	START_UPDATE

Constructor Summary

UpdateTaxonomyState(String taxonomyName, String status, Integer visitedCategories, Integer toUpdateCategories, Integer allCategories, Long startTime, Long lastTime)

UpdateTaxonomyState(String taxonomyName, String status, Integer visitedCategories, Integer toUpdateCategories, Integer allCategories, Long startTime, Long lastTime, Locale locale)

Method Summary

Integer	getAllCategories() Returns the number of all categories.
Long	getEndTime()
Long	getLastTime() Returns the last time in miliseconds an entry for the actual update has been stored.
Long	getStartTime() Returns the last start time in miliseconds an entry for the actual update has been stored.
String	getStatus() Returns the update status.
String	getStatusMessage()
String	getTaxonomyName() Returns the taxonomy name.
Integer	getToUpdateCategories() Returns the total number of categories which have to be updated.
Integer	getVisitedCategories() Returns the number of already processed categories.

Methods inherited from class java.lang.Object

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

Field Detail

NO_UPDATE

public static final String NO_UPDATE

See Also:

Constant Field Values

START_UPDATE

public static final String START_UPDATE

See Also:

Constant Field Values

ACTIVE_UPDATE

public static final String ACTIVE_UPDATE

See Also:

Constant Field Values

END_UPDATE

public static final String END_UPDATE

See Also:

Constant Field Values

FAILED_UPDATE

public static final String FAILED_UPDATE

See Also:

Constant Field Values

NO_INFO_UPDATE

public static final String NO_INFO_UPDATE

See Also:

Constant Field Values

Constructor Detail

UpdateTaxonomyState

public UpdateTaxonomyState(String taxonomyName,
                           String status,
                           Integer visitedCategories,
                           Integer toUpdateCategories,
                           Integer allCategories,
                           Long startTime,
                           Long lastTime)

UpdateTaxonomyState

public UpdateTaxonomyState(String taxonomyName,
                           String status,
                           Integer visitedCategories,
                           Integer toUpdateCategories,
                           Integer allCategories,
                           Long startTime,
                           Long lastTime,
                           Locale locale)

Method Detail

getAllCategories

public Integer getAllCategories()

Returns the number of all categories. Null or undefined if no update was started so far or the last update failed.

Returns:

getLastTime

public Long getLastTime()

Returns the last time in miliseconds an entry for the actual update has been stored. Null or undefined if no update was started so far or the last update failed.

Returns:

getEndTime

public Long getEndTime()

getStartTime

public Long getStartTime()

Returns the last start time in miliseconds an entry for the actual update has been stored. Null or undefined if no update was started so far or the last update failed.

Returns:

getStatus

public String getStatus()

Returns the update status.

Returns:

getStatusMessage

public String getStatusMessage()

getTaxonomyName

public String getTaxonomyName()

Returns the taxonomy name. Returns the Null or undefined if no update was started so far or the last update failed.

Returns:

getVisitedCategories

public Integer getVisitedCategories()

Returns the number of already processed categories. Returns the Null or undefined if no update was started so far or the last update failed.

Returns:

getToUpdateCategories

public Integer getToUpdateCategories()

Returns the total number of categories which have to be updated. Returns the Null or undefined if no update was started so far or the last update failed.

Returns: