com.plumtree.portalpages.admin.ptutilities.diagnostic
Interface IDiagnosticPage

All Known Implementing Classes:

AdaptiveLayoutsPage, DynamicLoadsPage, RelatedServersPage, RemoteHostsPage

public interface IDiagnosticPage

This interface describes the components required for a Diagnostic Page in the Server Diagnostic Editor.

Method Summary

EditorDP	GetDiagnosticPage() Get an instance of the Display Page for this Diagnostic Page.
java.lang.String	GetHelperRepostControlName() Get the name of the EditorHelperRepostControl to execute when this page is displayed.
java.lang.String	GetHelpTopic()
int	GetSecondaryTipID()
int	GetTipID()
int	GetTipTitleID()
boolean	HasTip() This method tells the diagnostic page framework whether or not to display a tip.
void	Init(AActivitySpace _asOwner) This method should register any necessary Models, Views, or extra DisplayPages.
void	RunDiagnosticTest(AActivitySpace _asOwner) This method is called every time the user switches to this particular page.

Method Detail

GetDiagnosticPage

EditorDP GetDiagnosticPage()

Get an instance of the Display Page for this Diagnostic Page. This page will be registered automatically.

Returns:

EditorDP an instance of the Display Page for this Diagnostic Page.

GetHelperRepostControlName

java.lang.String GetHelperRepostControlName()

Get the name of the EditorHelperRepostControl to execute when this page is displayed. This control needs to be registered manually in the IDiagnosticPage.Init() method.

Returns:

String The MVC name for the EditorHelperRepostControl to call for this page. May be null.

Init

void Init(AActivitySpace _asOwner)

This method should register any necessary Models, Views, or extra DisplayPages. I.E. _asOwner.RegisterView(), etc... This should not register the main Display Page. The main Display Page should be returned by the GetDiagnosticPage() method and will be registered automatically.

RunDiagnosticTest

void RunDiagnosticTest(AActivitySpace _asOwner)

This method is called every time the user switches to this particular page. This method should initialize or refresh the data on the page. Initializing the data should not be done in the Model.Init() method, as this is called when entering the page, and running all tests at once takes too long.

GetHelpTopic

java.lang.String GetHelpTopic()

Returns:

String The Help Topic for this Diagnostic Page. Null means to use the generic help page.

HasTip

boolean HasTip()

This method tells the diagnostic page framework whether or not to display a tip.

Returns:

True implies display a tip.

GetTipTitleID

int GetTipTitleID()

Returns:

int The tip title ID. -1 means no tip.

GetTipID

int GetTipID()

Returns:

int The tip ID. -1 means no tip.

GetSecondaryTipID

int GetSecondaryTipID()

Returns:

int The secondary tip ID. -1 means no tip.