com.bmc.arsys.api
Class ChangeFieldAction

java.lang.Object
  com.bmc.arsys.api.Action
      com.bmc.arsys.api.ChangeFieldAction

All Implemented Interfaces:

ActiveLinkAction, Serializable, Cloneable

public class ChangeFieldAction
extends Action
implements ActiveLinkAction, Cloneable, Serializable

The ChangeFieldAction class is used to change display characteristics of fields.

See Also:

Serialized Form

Constructor Summary

ChangeFieldAction()
constructor

ChangeFieldAction(int option, int fieldId, String charMenu, DisplayPropertyMap props, int focus, int accessOption)

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.
int	getAccessOption() Returns field access, whether Enabled or Disabled.
String	getCharMenu() Returns whether menu is attached to field or not.
int	getFieldId() Returns field ID.
int	getFocus() Returns whether focus is set to field or not.
int	getOption() Returns option which is a bitmask.
DisplayPropertyMap	getProps() Returns display properties of field, whether Hidden or Visible.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setAccessOption(int accessOption) Sets field access, whether Enabled or Disabled.
void	setCharMenu(String charMenu) Sets whether menu is attached to field or not.
void	setFieldId(int fieldId) Sets field ID.
void	setFocus(int focus) Sets whether focus is set to field or not.
void	setOption(int option) Sets the option which is a bitmask.
void	setProps(DisplayPropertyMap props) Sets display properties of field, whether Hidden or Visible.
String	toString() Returns a string description of the object.

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

equals, getActionType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeFieldAction

public ChangeFieldAction()

constructor

ChangeFieldAction

public ChangeFieldAction(int option,
                         int fieldId,
                         String charMenu,
                         DisplayPropertyMap props,
                         int focus,
                         int accessOption)

Method Detail

getOption

public int getOption()

Returns option which is a bitmask.

See Also:

Constants.AR_FIELD_CHAR_OPTION_REFERENCE

setOption

public void setOption(int option)

Sets the option which is a bitmask.

See Also:

Constants.AR_FIELD_CHAR_OPTION_REFERENCE

getFieldId

public int getFieldId()

Returns field ID.

setFieldId

public void setFieldId(int fieldId)

Sets field ID.

getCharMenu

public String getCharMenu()

Returns whether menu is attached to field or not.

setCharMenu

public void setCharMenu(String charMenu)

Sets whether menu is attached to field or not.

getProps

public DisplayPropertyMap getProps()

Returns display properties of field, whether Hidden or Visible.

setProps

public void setProps(DisplayPropertyMap props)

Sets display properties of field, whether Hidden or Visible.

getFocus

public int getFocus()

Returns whether focus is set to field or not.

setFocus

public void setFocus(int focus)

Sets whether focus is set to field or not.

getAccessOption

public int getAccessOption()

Returns field access, whether Enabled or Disabled.

setAccessOption

public void setAccessOption(int accessOption)

Sets field access, whether Enabled or Disabled.

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Action

Throws:

CloneNotSupportedException

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 Action

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

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 Action

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Action