com.google.enterprise.adaptor

Interface StatusSource

public interface StatusSource

A source of Status messages.

Method Summary

Modifier and Type	Method and Description
String	getName(Locale locale) Get the name of this source, for displaying to the user.
Status	retrieveStatus() Retrieve the current status.

Method Detail

retrieveStatus

Status retrieveStatus()

Retrieve the current status. This method should return quickly, within the order of ten milliseconds. That necessitates that most implementations perform their status checks outside of this method. This method should never return null.

Returns:

Status current Status

getName

String getName(Locale locale)

Get the name of this source, for displaying to the user. This method should never return null.

Parameters:

locale - non-null locale for localization.

Returns:

String name of this source