AR System Java API

com.bmc.arsys.api
Class View

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
      extended by 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.
 ObjectPropertyMap getObjectProperties()
          Returns the object properties associated with a SCC integration.
 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 setObjectProperties(ObjectPropertyMap props)
          Sets the object properties associated with a Source Code Control (SCC) integration.
 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.


setObjectProperties

public void setObjectProperties(ObjectPropertyMap props)
Sets the object properties associated with a Source Code Control (SCC) integration.

In the AR System, server objects have a list of properties, represented as tag-value pairs. Each PropInfo object contains a tag and a Value that is used to store the value for a given tag. If you do not specify the object properties, an object properties list with zero properties will be associated with the field.

Parameters:
props - An array of PropInfo objects

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.


getObjectProperties

public ObjectPropertyMap getObjectProperties()
Returns the object properties associated with a SCC integration.


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

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.