com.remedy.arsys.api
Class View

java.lang.Object
  |
  +--com.remedy.arsys.api.ObjectBase
        |
        +--com.remedy.arsys.api.View

All Implemented Interfaces:

java.lang.Cloneable, IARPersistentObject

public class View

extends ObjectBase

implements IARPersistentObject, java.lang.Cloneable

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

Fields inherited from class com.remedy.arsys.api.ObjectBase

m_changeFlags

Method Summary

void	activate() AR System reserved method.
void	clear() Clears all of the references to member objects.
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
void	create() Creates this object on the AR System server.
PropInfo[]	getDisplayProperties() Returns display properties information.
ViewKey	getKey() Returns unique identifier for view.
java.lang.String	getLocale() Returns the locale.
NameID	getSchemaName() Returns the name of the form that the VUI is linked to.
FieldID	getVUIId() Returns the internal ID of the VUI.
int	getVUIType() Returns the VUI type.
void	load() Populates this object with information from the AR System server.
void	load(ViewCriteria criteria) Populates this object with information specified by ViewCriteria from the AR System server.
void	passivate() AR System reserved method.
void	remove() Removes this object on the AR System server.
void	setContext(ARServerUser ctxt) Associates ARServerUser information with this view object.
void	setDisplayProperties(PropInfo[] properties) Sets display properties information.
void	setKey(ViewKey key) Sets unique identifier for view.
void	setLocale(java.lang.String locale) Sets the locale.
void	setSchemaName(NameID schemaName) Associates the VUI with a form.
void	setVUIId(FieldID viewID) Assigns an internal ID for the VUI.
void	setVUIType(int vuiType) Sets the VUI type.
void	store() Updates this view on the database
void	unsetContext() Removes the association to a specific user context.

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

equals, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, hashCode, resetChangeFlags, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

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

Method Detail

setSchemaName

public void setSchemaName(NameID schemaName)

Associates the VUI with a form.

setVUIId

public void setVUIId(FieldID 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(PropInfo[] 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). The system uses the first VUI returned by the find.ViewFactory or findObjects.ViewFactory methods if you do not specify a default view.
• 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 (refer to ByteListInfo). The background image for the details pane. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows 3.0 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 (refer to ByteListInfo). The icon image for the title bar. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows 3.0 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). AR System 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.

getSchemaName

public NameID getSchemaName()

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

getVUIId

public FieldID getVUIId()

Returns the internal ID of the VUI.

getDisplayProperties

public PropInfo[] getDisplayProperties()

Returns display properties information. See setDisplayProperties.

getLocale

public java.lang.String getLocale()

Returns the locale.

setLocale

public void setLocale(java.lang.String locale)

Sets the locale.

getVUIType

public int getVUIType()

Returns the VUI type.

setVUIType

public void setVUIType(int vuiType)

Sets the VUI type.

setContext

public void setContext(ARServerUser ctxt)

Associates ARServerUser information with this view object.

Specified by:

setContext in interface IARPersistentObject

unsetContext

public void unsetContext()

Removes the association to a specific user context.

Specified by:

unsetContext in interface IARPersistentObject

clear

public void clear()

Clears all of the references to member objects.

Specified by:

clear in interface IARPersistentObject

Overrides:

clear in class ObjectBase

getKey

public ViewKey getKey()

Returns unique identifier for view.

setKey

public void setKey(ViewKey key)

Sets unique identifier for view.

clone

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

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

Overrides:

clone in class ObjectBase

create

public void create()
            throws ARException

Creates this object on the AR System server.

Specified by:

create in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not saved

remove

public void remove()
            throws ARException

Removes this object on the AR System server.

Specified by:

remove in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not removed

load

public void load()
          throws ARException

Populates this object with information from the AR System server.

Specified by:

load in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not loaded

load

public void load(ViewCriteria criteria)
          throws ARException

Populates this object with information specified by ViewCriteria from the AR System server.

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not loaded

store

public void store()
           throws ARException

Updates this view on the database

Specified by:

store in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not saved

activate

public void activate()

Description copied from interface: IARPersistentObject

AR System reserved method.

Specified by:

activate in interface IARPersistentObject

passivate

public void passivate()

Description copied from interface: IARPersistentObject

AR System reserved method.

Specified by:

passivate in interface IARPersistentObject