com.bmc.arsys.api
Class View

java.lang.Object
  com.bmc.arsys.api.ObjectBase
      com.bmc.arsys.api.View

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class View
extends ObjectBase
implements IARPersistentObject, Cloneable, Serializable

The View represents the form view (VUI) with the indicated name on the specified server.

See Also:

Serialized Form

Constructor Summary

View()

View(String formName, int viewID)

View(String formName, String viewName, int viewID, ViewDisplayPropertyMap properties)

View(String formName, String viewName, int viewID, ViewDisplayPropertyMap properties, String locale, int vuiType)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
ViewDisplayPropertyMap	getDisplayProperties() Returns display properties information.
String	getFormName() Returns the name of the form that the VUI is linked to.
ViewKey	getKey() Returns unique identifier for view.
String	getLocale() Returns the locale.
int	getVUIId() Returns the internal ID of the VUI.
int	getVUIType() Returns the VUI type.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setDisplayProperties(ViewDisplayPropertyMap properties) Sets display properties information.
void	setFormName(String formName) Associates the VUI with a form.
void	setKey(ViewKey key) Sets unique identifier for view.
void	setLocale(String locale) Sets the locale.
void	setPermissions(List<PermissionInfo> permissionList) Sets the permissions of the AR System object.
void	setVUIId(int viewID) Assigns an internal ID for the VUI.
void	setVUIType(int vuiType) Sets the VUI type.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.ObjectBase

appendDiaryText, clear, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bmc.arsys.api.IARPersistentObject

appendDiaryText, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner

Constructor Detail

View

public View()

View

public View(String formName,
            String viewName,
            int viewID,
            ViewDisplayPropertyMap properties,
            String locale,
            int vuiType)

View

public View(String formName,
            String viewName,
            int viewID,
            ViewDisplayPropertyMap properties)

View

public View(String formName,
            int viewID)

Method Detail

setPermissions

public void setPermissions(List<PermissionInfo> permissionList)

Description copied from class: ObjectBase

Sets the permissions of the AR System object.

Specified by:

setPermissions in interface IARPersistentObject

Overrides:

setPermissions in class ObjectBase

setFormName

public void setFormName(String formName)

Associates the VUI with a form.

setVUIId

public void setVUIId(int viewID)

Assigns an internal ID for the VUI. The IDs of all VUIs and fields associated with a form must be unique. Specify 0 for this parameter if you want the system to generate the ID. Otherwise, specify a value between 536870912 and and 2147483647 (limited by AR_MAX_RESERVED_FIELD_ID in arstruct.h).

setDisplayProperties

public void setDisplayProperties(ViewDisplayPropertyMap properties)

Sets display properties information.

• AR_DPROP_VUI_DEFAULT (unsigned long). A flag identifying the default view (VUI) for the form. A value of 1 identifies the default VUI (with all other VUIs having a value of 0).
• AR_DPROP_PANE_LAYOUT (integer). A value indicating how the panes of the VUI are arranged. This property also specifies whether the layout is locked to prevent the user from changing it.

  -1: Results pane left of details, prompt pane on top, locked.
  -2: Details pane left of results, prompt pane on top, locked.
  -3: Results pane above details, prompt pane on top, locked.
  -4: Details pane above results, prompt pane on top, locked.
  -5: Results pane left of details, prompt pane on bottom, locked.
  -6: Details pane left of results, prompt pane on bottom, locked.
  -7: Results pane above details, prompt pane on bottom, locked.
  -8: Details pane above results, prompt pane on bottom, locked.
  1: Results pane left of details, prompt pane on top, unlocked.
  2: Details pane left of results, prompt pane on top, unlocked.
  3: Results pane above details, prompt pane on top, unlocked.
  4: Details pane above results, prompt pane on top, unlocked.
  5: Results pane left of details, prompt pane on bottom, unlocked.
  6: Details pane left of results, prompt pane on bottom, unlocked.
  7: Results pane above details, prompt pane on bottom, unlocked.
  8: Details pane above results, prompt pane on bottom, unlocked.

• AR_DPROP_DETAIL_PANE_COLOR (character string). The background color of the details pane. Specify the color as #BBGGRR, a string concatenating the two-digit hexadecimal values for blue, green, and red.
• AR_DPROP_DETAIL_PANE_IMAGE (see ByteListValue). The background image for the details pane. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows bitmap (.bmp) and DIB (.dib) format. Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg) format (see AR_DPROP_PUSH_BUTTON_IMAGE).
• AR_DPROP_IMAGE_ALIGN (unsigned long). A value indicating the vertical alignment of the background image for the details pane.

  1: Top-aligned (AR_DVAL_ALIGN_TOP).
  2: Centered (AR_DVAL_ALIGN_MIDDLE) (default setting).
  3: Expand to fill (AR_DVAL_ALIGN_FILL).
  4: Bottom-aligned (AR_DVAL_ALIGN_BOTTOM).
  5: Tile to fill (AR_DVAL_ALIGN_TILE).

• AR_DPROP_IMAGE_JUSTIFY (unsigned long). A value indicating the horizontal justification of the background image for the details pane.

  1: Left-aligned (AR_DVAL_JUSTIFY_LEFT).
  2: Centered (AR_DVAL_JUSTIFY_CENTER).
  3: Expand to fill (AR_DVAL_JUSTIFY_FILL).
  4: Right-aligned (AR_DVAL_JUSTIFY_RIGHT).
  5: Tile to fill (AR_DVAL_JUSTIFY_TILE).

• AR_DPROP_TITLE_BAR_ICON_IMAGE (see ByteListValue). The icon image for the title bar. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows bitmap (.bmp) and DIB (.dib) format. Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg) format.
• AR_DPROP_DETAIL_PANE_WIDTH (integer). The width of the details pane, in form coordinates. Negative values are reserved for future use.
• AR_DPROP_DETAIL_PANE_HEIGHT (integer). The height of the details pane, in form coordinates.
• AR_DPROP_DETAIL_BANNER_VISIBILITY (unsigned long). A value indicating whether the details pane is visible. Specify 0 for invisible, 1 for visible.
• AR_DPROP_RESULT_BANNER_VISIBILITY (unsigned long). A value indicating whether the results pane is visible. Specify 0 for invisible, 1 for visible.
• AR_DPROP_ALIAS_SINGULAR (character string). The singular form of the name for the logical items represented by entries in the form this view is associated with (such as help desk calls). Remedy User displays this name instead of the default "request" when referring to form entries.
• AR_DPROP_ALIAS_PLURAL (character string). The plural form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
• AR_DPROP_ALIAS_SHORT_SINGULAR (character string). A short, singular form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
• AR_DPROP_ALIAS_SHORT_PLURAL (character string). A short, plural form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
• AR_DPROP_ALIAS_ABBREV_SINGULAR (character string). A very short, singular form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
• AR_DPROP_ALIAS_ABBREV_PLURAL (character string). A very short, plural form of the name for the logical items represented by entries in the form this view is associated with (see AR_DPROP_ALIAS_SINGULAR).
• AR_DPROP_NAMED_SEARCHES (character string). A list of administrator-defined searches. It is encoded in the same format as qualifications in .arf files. This is only for AR System internal use.
• AR_DPROP_MENU_ACCESS (character string). A list of client interface items an administrator can control. It is encoded in the same format as qualifications in .arf files. This is only for AR System internal use.
• AR_DPROP_QUERY_LIST_COLOR (character string). The name of the field whose value for a given entry controls the display color of that entry in a query results list, and a list of field values and their corresponding colors. This is only for AR System internal use.

getFormName

public String getFormName()

Returns the name of the form that the VUI is linked to.

getVUIId

public int getVUIId()

Returns the internal ID of the VUI.

getDisplayProperties

public ViewDisplayPropertyMap getDisplayProperties()

Returns display properties information. See setDisplayProperties.

getLocale

public String getLocale()

Returns the locale.

setLocale

public void setLocale(String locale)

Sets the locale.

getVUIType

public int getVUIType()

Returns the VUI type.

setVUIType

public void setVUIType(int vuiType)

Sets the VUI type.

getKey

public ViewKey getKey()

Returns unique identifier for view.

setKey

public void setKey(ViewKey key)

Sets unique identifier for view.

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class ObjectBase

Throws:

CloneNotSupportedException

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class ObjectBase

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 ObjectBase

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class ObjectBase

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal