com.remedy.arsys.api
Class Diary

java.lang.Object
  |
  +--com.remedy.arsys.api.Diary

public class Diary

extends java.lang.Object

The Diary class is used to set or retrieve the values of diary fields. The Diary class is a collection of DiaryInfo objects. It contains a string representation of all the DiaryInfo objects in encoded form. The list of DiaryInfo objects can be retrieved using the decode method.

Constructor Summary

Diary(java.lang.String diaryString)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
DiaryInfo[]	decode(ARServerUser userSession) Takes the formatted string returned for all diary fields and decodes it into an array of diary entries.
boolean	equals(java.lang.Object anObject) Use this method for checking equality of Diary.
java.lang.String	getValue() Returns value of diary field (as a string of encoded characters).

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Diary

public Diary(java.lang.String diaryString)

Method Detail

getValue

public java.lang.String getValue()

Returns value of diary field (as a string of encoded characters).

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality of Diary. The result is true if and only if the argument is not null and is a Diary object that represents the same content.

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class java.lang.Object

decode

public DiaryInfo[] decode(ARServerUser userSession)
                   throws ARException

Takes the formatted string returned for all diary fields and decodes it into an array of diary entries.

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if diary information is not decoded