ides.api.notice
Interface NoticeManager

public interface NoticeManager

Interface for the manager of messages displayed to the user. Three types of notices are supported: information, warning, and error.

Author:

Lenko Grigorov

Method Summary

int	postErrorTemporary(java.lang.String digest, java.lang.String fullBody) Posts an error notice which automatically expires if it is not revoked or if the user does not discard it sooner.
int	postErrorUntilRevoked(java.lang.String digest, java.lang.String fullBody) Posts an error notice which does not automatically expire.
int	postInfoTemporary(java.lang.String digest, java.lang.String fullBody) Posts an information notice which automatically expires if it is not revoked or if the user does not discard it sooner.
int	postInfoUntilRevoked(java.lang.String digest, java.lang.String fullBody) Posts an information notice which does not automatically expire.
int	postWarningTemporary(java.lang.String digest, java.lang.String fullBody) Posts a warning notice which automatically expires if it is not revoked or if the user does not discard it sooner.
int	postWarningUntilRevoked(java.lang.String digest, java.lang.String fullBody) Posts a warning notice which does not automatically expire.
void	revoke(int id) Revokes a notice.

Method Detail

postInfoTemporary

int postInfoTemporary(java.lang.String digest,
                      java.lang.String fullBody)

Posts an information notice which automatically expires if it is not revoked or if the user does not discard it sooner.

Parameters:

digest - a short summary of the notice

fullBody - the complete text of the notice

Returns:

the ID of the notice which can be used to revoke it

See Also:

revoke(int), postInfoUntilRevoked(String, String)

postInfoUntilRevoked

int postInfoUntilRevoked(java.lang.String digest,
                         java.lang.String fullBody)

Posts an information notice which does not automatically expire. It disappears only if it is revoked or if the user discards it.

Parameters:

digest - a short summary of the notice

fullBody - the complete text of the notice

Returns:

the ID of the notice which can be used to revoke it

See Also:

revoke(int), postInfoTemporary(String, String)

postWarningTemporary

int postWarningTemporary(java.lang.String digest,
                         java.lang.String fullBody)

Posts a warning notice which automatically expires if it is not revoked or if the user does not discard it sooner.

Parameters:

digest - a short summary of the notice

fullBody - the complete text of the notice

Returns:

the ID of the notice which can be used to revoke it

See Also:

revoke(int), postWarningUntilRevoked(String, String)

postWarningUntilRevoked

int postWarningUntilRevoked(java.lang.String digest,
                            java.lang.String fullBody)

Posts a warning notice which does not automatically expire. It disappears only if it is revoked or if the user discards it.

Parameters:

digest - a short summary of the notice

fullBody - the complete text of the notice

Returns:

the ID of the notice which can be used to revoke it

See Also:

revoke(int), postInfoTemporary(String, String)

postErrorTemporary

int postErrorTemporary(java.lang.String digest,
                       java.lang.String fullBody)

Posts an error notice which automatically expires if it is not revoked or if the user does not discard it sooner.

Parameters:

digest - a short summary of the notice

fullBody - the complete text of the notice

Returns:

the ID of the notice which can be used to revoke it

See Also:

revoke(int), postErrorUntilRevoked(String, String)

postErrorUntilRevoked

int postErrorUntilRevoked(java.lang.String digest,
                          java.lang.String fullBody)

Posts an error notice which does not automatically expire. It disappears only if it is revoked or if the user discards it.

Parameters:

digest - a short summary of the notice

fullBody - the complete text of the notice

Returns:

the ID of the notice which can be used to revoke it

See Also:

revoke(int), postInfoTemporary(String, String)

revoke

void revoke(int id)

Revokes a notice. If the notice with given ID does not exist, the method call is ignored.

Parameters:

id - the ID of the notice to be revoked