com.sap.ip.me.api.services.systemnews
Class News

java.lang.Object
  extended bycom.sap.ip.me.api.services.systemnews.News

public abstract class News
extends java.lang.Object

This class provides a public interface for accessing System News

Author:
SAP

Constructor Summary
News()
          Constructor for the News object
 
Method Summary
abstract  void addListener(NewsListener nl)
          Registeres a listener which will be fired when new messages arrive
static News getInstance()
          Gets the News' instance
abstract  NewsIterator getIterator()
          Gets the NewsIterator for parsing system messages
abstract  boolean isRegistered(NewsListener nl)
          Determines whether a NewsListener is registered or not
abstract  boolean messagesAvailable(boolean newMessagesOnly)
          Determines whether system messages are available
abstract  boolean removeListener(NewsListener nl)
          Removes a registered NewsListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

News

public News()
Constructor for the News object

Method Detail

getInstance

public static News getInstance()
Gets the News' instance

Returns:
returns the singleton News instance

getIterator

public abstract NewsIterator getIterator()
Gets the NewsIterator for parsing system messages

Returns:
returns a NewsIterator object

addListener

public abstract void addListener(NewsListener nl)
Registeres a listener which will be fired when new messages arrive

Parameters:
nl - The listener which will be registered

removeListener

public abstract boolean removeListener(NewsListener nl)
Removes a registered NewsListener

Parameters:
nl - The listener which will be removed
Returns:
returns true, if the listener was removed sucessfully

isRegistered

public abstract boolean isRegistered(NewsListener nl)
Determines whether a NewsListener is registered or not

Parameters:
nl - The listener which will be checked
Returns:
returns true, if the listener is registered

messagesAvailable

public abstract boolean messagesAvailable(boolean newMessagesOnly)
Determines whether system messages are available

Parameters:
newMessagesOnly - If true, this method will only check for unread messages
Returns:
returns true, if (new) messages are available


Copyright © 2005 SAP AG. All Rights Reserved.