com.bmc.arsys.api
Interface IARPersistentObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActiveLink, ActiveLinkGuide, ApplicationContainer, AttachmentField, AttachmentPoolField, CharacterField, ColumnField, Container, ControlField, CurrencyField, DataDictionaryMenu, DateOnlyField, DateTimeField, DecimalField, DiaryField, DisplayField, DisplayOnlyForm, Escalation, Field, FieldDataDictionaryMenu, FileMenu, Filter, FilterGuide, Form, FormDataDictionaryMenu, Image, IntegerField, JoinForm, ListMenu, Menu, ObjectBase, PackingList, PageField, PageHolderField, QueryMenu, RealField, RegularForm, SelectionField, ServerInfoMenu, SqlMenu, TableField, TimeOnlyField, TrimField, VendorForm, View, ViewField, ViewForm, WebService

public interface IARPersistentObject
extends Serializable

The IARPersistentObject interface defines methods for all AR System server objects.

Method Summary

void	appendDiaryText(String appendedText)
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.
void	setDiary(DiaryListValue diary) The setDiary( ) method of these objects takes only the plain dairy string (without the user and time).
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.

Method Detail

setName

void setName(String name)

Sets name of the object.

getName

String getName()

Returns name of AR System object.

getNewName

String getNewName()

Returns new name of AR System object.

setNewName

void setNewName(String newName)

Sets new name of AR System object.

getPermissions

List<PermissionInfo> getPermissions()

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

setPermissions

void setPermissions(List<PermissionInfo> permissions)

Sets the permissions of the AR System object.

getHelpText

String getHelpText()

Returns help text of AR System objects.

setHelpText

void setHelpText(String helpText)

Sets help text of AR System object.

getLastUpdateTime

Timestamp getLastUpdateTime()

Returns time that the object was last modified.

getOwner

String getOwner()

Returns owner of AR System object.

setOwner

void setOwner(String owner)

Sets owner of AR System object.

getLastChangedBy

String getLastChangedBy()

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

setLastChangedBy

void setLastChangedBy(String changedBy)

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

getDiary

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.

setDiary

void setDiary(DiaryListValue diary)

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

appendDiaryText

void appendDiaryText(String appendedText)