com.remedy.arsys.api
Class ObjectBase

java.lang.Object
  com.remedy.arsys.api.ObjectBase

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ActiveLink, Container, Escalation, Field, Filter, Menu, Schema, View

public abstract class ObjectBase

extends java.lang.Object

implements java.lang.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.

Field Summary

protected CriteriaFlags	m_changeFlags
protected PermissionInfo[]	m_permissionList

Constructor Summary

protected	ObjectBase()
protected	ObjectBase(java.lang.String name, PermissionInfo[] permissionList, java.lang.String helpText, long lastUpdateTime, java.lang.String owner, java.lang.String lastChangedBy, java.lang.String diaryStr)

Method Summary

void	clear() Clears all of the references to member objects.
java.lang.Object	clone() Makes a deep copy of the object.
boolean	equals(java.lang.Object anObject)
java.lang.String	getDiary() The getDiary( ) method on any server object returns a string that consists of all the diary items (time stamp, user and diary string ).
java.lang.String	getHelpText() Returns help text of AR System objects.
AccessNameID	getLastChangedBy() Returns name of last person who modified the AR System object.
Timestamp	getLastUpdateTime() Returns time that the object was last modified.
NameID	getName() Returns name of AR System object.
NameID	getNewName() Returns new name of AR System object.
AccessNameID	getOwner() Returns owner of AR System object.
PermissionInfo[]	getPermissions() Returns permissions (access control) of AR System objects.
int	hashCode() Returns the hash code value for this instance of the current class.
protected void	resetChangeFlags() Internal AR System use only.
void	setDiary(java.lang.String diary) The setDiary( ) method of these objects takes only the plain dairy string (without the user and time).
void	setHelpText(java.lang.String helpText) Sets help text of AR System object.
void	setLastChangedBy(AccessNameID changedBy) Sets name of last person who last modified the AR System object.
void	setName(NameID name) Sets name of the object.
void	setNewName(NameID newName) Sets new name of AR System object.
void	setOwner(AccessNameID owner) Sets owner of AR System object.
void	setPermissions(PermissionInfo[] permissions) Sets the permissions of the AR System object.

Methods inherited from class java.lang.Object

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

Field Detail

m_permissionList

protected PermissionInfo[] m_permissionList

m_changeFlags

protected CriteriaFlags m_changeFlags

Constructor Detail

ObjectBase

protected ObjectBase()

ObjectBase

protected ObjectBase(java.lang.String name,
                     PermissionInfo[] permissionList,
                     java.lang.String helpText,
                     long lastUpdateTime,
                     java.lang.String owner,
                     java.lang.String lastChangedBy,
                     java.lang.String diaryStr)

Method Detail

clear

public void clear()

Clears all of the references to member objects.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Makes a deep copy of the object.

Throws:

java.lang.CloneNotSupportedException

setName

public void setName(NameID name)

Sets name of the object.

getName

public NameID getName()

Returns name of AR System object.

getNewName

public NameID getNewName()

Returns new name of AR System object.

setNewName

public void setNewName(NameID newName)

Sets new name of AR System object.

getPermissions

public PermissionInfo[] getPermissions()

Returns permissions (access control) of AR System objects. Not applicable for menus, active links, filters, or escalations.

setPermissions

public void setPermissions(PermissionInfo[] permissions)

Sets the permissions of the AR System object.

getHelpText

public java.lang.String getHelpText()

Returns help text of AR System objects.

setHelpText

public void setHelpText(java.lang.String helpText)

Sets help text of AR System object.

getLastUpdateTime

public Timestamp getLastUpdateTime()

Returns time that the object was last modified.

getOwner

public AccessNameID getOwner()

Returns owner of AR System object.

setOwner

public void setOwner(AccessNameID owner)

Sets owner of AR System object.

getLastChangedBy

public AccessNameID getLastChangedBy()

Returns name of last person who modified the AR System object.

setLastChangedBy

public void setLastChangedBy(AccessNameID changedBy)

Sets name of last person who last modified the AR System object.

getDiary

public java.lang.String 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 Diary object with this string and decode it, using the Diary.decode(com.remedy.arsys.api.ARServerUser) method to get the actual results.

setDiary

public void setDiary(java.lang.String diary)

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

resetChangeFlags

protected void resetChangeFlags()

Internal AR System use only.

equals

public boolean equals(java.lang.Object anObject)

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.