Status

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.enterprise.adaptor
Interface Status

public interface Status

Multi-state indicator providing the user with a notification of broken parts of the system. A Status instance should not change its results over time; instead a StatusSource should return different instances as the status changes.

Nested Class Summary
`static class`	`Status.Code` Available statuses for displaying state indicators on the dashboard.

Method Summary
`Status.Code`	`getCode()` The code to represent the state of the status.
`String`	`getMessage(Locale locale)` A message appropriate for displaying to an end-user concerning the state of the status.

Method Detail

getCode

Status.Code getCode()

The code to represent the state of the status. Will not return null.

Returns:: the state of the status, but never null.

getMessage

String getMessage(Locale locale)

A message appropriate for displaying to an end-user concerning the state of the status. A message is not required and is only encouraged if it provides helpful information. For example, if getCode() returns Status.Code.NORMAL, then a message is typically discouraged, unless it provides statistics or additional information not obvious when provided StatusSource.getName(java.util.Locale) and getCode().

Parameters:: locale - non-null locale for localization.
Returns:: a localized message for the end-user, or null if one is not necessary.