AR System Java API

com.bmc.arsys.api
Class ObjectBase

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable
Direct Known Subclasses:
ActiveLink, Container, Escalation, Field, Filter, Form, Image, Menu, View

public abstract class ObjectBase
extends Object
implements IARPersistentObject, Cloneable

The ObjectBase class is used to store the information common to most AR System objects, for example, their help text, change diaries, permissions, and so on. All the Java API classes are derived/inherited from this class.

See Also:
Serialized Form

Method Summary
 void appendDiaryText(String appendedText)
           
 void clear()
          Clears all of the references to member objects.
 Object clone()
          Makes a deep copy of the object.
 boolean equals(Object obj)
           
 CriteriaFlags getChangeFlags()
          Returns a CriteriaFlags instance that indicates changes made to the Object using setters.
 DiaryListValue getDiary()
          The getDiary( ) method on any server object returns a string that consists of all the diary items (time stamp, user and diary string ).
 String getHelpText()
          Returns help text of AR System objects.
 String getLastChangedBy()
          Returns name of last person who modified the AR System object.
 Timestamp getLastUpdateTime()
          Returns time that the object was last modified.
 String getName()
          Returns name of AR System object.
 String getNewName()
          Returns new name of AR System object.
 String getOwner()
          Returns owner of AR System object.
 List<PermissionInfo> getPermissions()
          Returns permissions (access control) of AR System objects.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setChangeFlags(ObjectBaseCriteria criteria)
           
 void setDiary(DiaryListValue diary)
          The setDiary( ) method of these objects takes only the plain dairy string (without the user and time).
 void setDiary(String encoded)
           
 void setHelpText(String helpText)
          Sets help text of AR System object.
 void setLastChangedBy(String changedBy)
          Sets name of last person who last modified the AR System object.
 void setName(String name)
          Sets name of the object.
 void setNewName(String newName)
          Sets new name of AR System object.
 void setOwner(String owner)
          Sets owner of AR System object.
 void setPermissions(List<PermissionInfo> permissions)
          Sets the permissions of the AR System object.
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

clear

public void clear()
Clears all of the references to member objects.


clone

public Object clone()
             throws CloneNotSupportedException
Makes a deep copy of the object.

Overrides:
clone in class Object
Throws:
CloneNotSupportedException

setName

public void setName(String name)
Sets name of the object.

Specified by:
setName in interface IARPersistentObject

getName

public String getName()
Returns name of AR System object.

Specified by:
getName in interface IARPersistentObject

getNewName

public String getNewName()
Returns new name of AR System object.

Specified by:
getNewName in interface IARPersistentObject

setNewName

public void setNewName(String newName)
Sets new name of AR System object.

Specified by:
setNewName in interface IARPersistentObject

getPermissions

public List<PermissionInfo> getPermissions()
Returns permissions (access control) of AR System objects. Not applicable for menus, active links, filters, or escalations.

Specified by:
getPermissions in interface IARPersistentObject

setPermissions

public void setPermissions(List<PermissionInfo> permissions)
Sets the permissions of the AR System object.

Specified by:
setPermissions in interface IARPersistentObject

getHelpText

public String getHelpText()
Returns help text of AR System objects.

Specified by:
getHelpText in interface IARPersistentObject

setHelpText

public void setHelpText(String helpText)
Sets help text of AR System object.

Specified by:
setHelpText in interface IARPersistentObject

getLastUpdateTime

public Timestamp getLastUpdateTime()
Returns time that the object was last modified.

Specified by:
getLastUpdateTime in interface IARPersistentObject

getOwner

public String getOwner()
Returns owner of AR System object.

Specified by:
getOwner in interface IARPersistentObject

setOwner

public void setOwner(String owner)
Sets owner of AR System object.

Specified by:
setOwner in interface IARPersistentObject

getLastChangedBy

public String getLastChangedBy()
Returns name of last person who modified the AR System object.

Specified by:
getLastChangedBy in interface IARPersistentObject

setLastChangedBy

public void setLastChangedBy(String changedBy)
Sets name of last person who last modified the AR System object.

Specified by:
setLastChangedBy in interface IARPersistentObject

getDiary

public DiaryListValue getDiary()
The getDiary( ) method on any server object returns a string that consists of all the diary items (time stamp, user and diary string ). This string is in encoded form. To get the actual values the user has to create a DiaryList object with this string and decode it, using the DiaryListValue.decode(java.lang.String) method to get the actual results.

Specified by:
getDiary in interface IARPersistentObject

setDiary

public void setDiary(DiaryListValue diary)
The setDiary( ) method of these objects takes only the plain dairy string (without the user and time).

Specified by:
setDiary in interface IARPersistentObject

setDiary

public void setDiary(String encoded)

appendDiaryText

public void appendDiaryText(String appendedText)
Specified by:
appendDiaryText in interface IARPersistentObject

setChangeFlags

public void setChangeFlags(ObjectBaseCriteria criteria)

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:
hashCode in class Object

getChangeFlags

public CriteriaFlags getChangeFlags()
Returns a CriteriaFlags instance that indicates changes made to the Object using setters.


toString

public String toString()
Overrides:
toString in class Object

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.