com.vodafone360.people.datatypes
Class SystemNotification

java.lang.Object
  extended by com.vodafone360.people.datatypes.BaseDataType
      extended by com.vodafone360.people.datatypes.PushEvent
          extended by com.vodafone360.people.datatypes.SystemNotification

public class SystemNotification
extends PushEvent

BaseDataType encapsulating a System notification message received from server This message contains a code and error test and should be routed to the approproate engine(s).


Nested Class Summary
static class SystemNotification.SysNotificationCode
          Enumeration of System Notification codes that can be returned from Server.
private static class SystemNotification.Tags
          Tags associated with SystemNotification item.
 
Field Summary
private  java.lang.String code
           
private  java.lang.String message
           
private  SystemNotification.SysNotificationCode mSysCode
           
 
Fields inherited from class com.vodafone360.people.datatypes.PushEvent
mEngineId, mMessageType, NAME
 
Constructor Summary
SystemNotification()
           
 
Method Summary
static SystemNotification createFromHashtable(java.util.Hashtable<java.lang.String,java.lang.Object> hash, EngineManager.EngineId engId)
          Create SystemNotification message from hashtable generated by Hessian-decoder.
 SystemNotification.SysNotificationCode getSysCode()
          Get current System Notification code.
 java.lang.String name()
          Return name of the current Data-type.
private  void setEngine()
          Set EngineId of Engine that needs to handle the System Notification.
private  void setValue(SystemNotification.Tags tag, java.lang.Object value)
          Sets the value of the member data item associated with the specified tag.
 java.lang.String toString()
          
 
Methods inherited from class com.vodafone360.people.datatypes.PushEvent
createPushEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

code

private java.lang.String code

message

private java.lang.String message

mSysCode

private SystemNotification.SysNotificationCode mSysCode
Constructor Detail

SystemNotification

public SystemNotification()
Method Detail

name

public java.lang.String name()
Return name of the current Data-type.

Overrides:
name in class PushEvent
Returns:
String containing name of the data-type.

createFromHashtable

public static SystemNotification createFromHashtable(java.util.Hashtable<java.lang.String,java.lang.Object> hash,
                                                     EngineManager.EngineId engId)
Create SystemNotification message from hashtable generated by Hessian-decoder.

Parameters:
hash - Hashtable containing SystemNotification parameters.
engId - ID for engine this message should be routed to.
Returns:
SystemNotification created from hashtable.

setValue

private void setValue(SystemNotification.Tags tag,
                      java.lang.Object value)
Sets the value of the member data item associated with the specified tag.

Parameters:
tag - Current tag
val - Value associated with the tag

setEngine

private void setEngine()
Set EngineId of Engine that needs to handle the System Notification.


getSysCode

public SystemNotification.SysNotificationCode getSysCode()
Get current System Notification code.

Returns:
current System Notification code.

toString

public java.lang.String toString()

Overrides:
toString in class PushEvent


JavaDoc