org.overlord.sramp.ui.client.services.growl
Interface IGrowlService

All Superinterfaces:

IService

All Known Implementing Classes:

GrowlService

public interface IGrowlService
extends IService

A lightweight notification service.

Author:

eric.wittmann@redhat.com

Method Summary

int	growl(String title, String message) Growls a simple message at the user.
int	growl(String title, String message, GrowlType type) Growls at the user.
int	growl(String title, String message, RemoteServiceException error) Called by clients to notify the user of an error.
void	onProgressComplete(int growlId, String title, String message) Called by clients to inform the growl service that a progress style growl has completed successfully.
void	onProgressComplete(int growlId, String title, com.google.gwt.user.client.ui.Widget message) Called by clients to inform the growl service that a progress style growl has completed successfully.
void	onProgressError(int growlId, String title, RemoteServiceException error) Called by clients to inform the growl service that a progress style growl has completed with an error.
void	onProgressError(int growlId, String title, String message) Called by clients to inform the growl service that a progress style growl has completed with an error.

Methods inherited from interface org.overlord.sramp.ui.client.services.IService

start

Method Detail

growl

int growl(String title,
          String message)

Growls a simple message at the user.

Parameters:

title -

message -

Returns:

the unique ID of the growl

growl

int growl(String title,
          String message,
          GrowlType type)

Growls at the user.

Parameters:

title -

message -

type -

Returns:

the unique ID of the growl

growl

int growl(String title,
          String message,
          RemoteServiceException error)

Called by clients to notify the user of an error.

Parameters:

title - the title for the growl dialog

message - the message to show the user

error - the error that occured

onProgressComplete

void onProgressComplete(int growlId,
                        String title,
                        String message)

Called by clients to inform the growl service that a progress style growl has completed successfully.

Parameters:

growlId - the ID of the growl to update - returned by a previous call to growl()

title - the new title for the growl dialog

message - the new message for the growl dialog

onProgressComplete

void onProgressComplete(int growlId,
                        String title,
                        com.google.gwt.user.client.ui.Widget message)

Called by clients to inform the growl service that a progress style growl has completed successfully.

Parameters:

growlId - the ID of the growl to update - returned by a previous call to growl()

title - the new title for the growl dialog

message - the new message for the growl dialog

onProgressError

void onProgressError(int growlId,
                     String title,
                     String message)

Called by clients to inform the growl service that a progress style growl has completed with an error.

Parameters:

growlId - the ID of the growl to update - returned by a previous call to growl()

title - the new title for the growl dialog

message - the new message for the growl dialog

onProgressError

void onProgressError(int growlId,
                     String title,
                     RemoteServiceException error)

Called by clients to inform the growl service that a progress style growl has completed with an error.

Parameters:

growlId - the ID of the growl to update - returned by a previous call to growl()

title - the new title for the growl dialog

error - the error that occurred