AR System Java API

com.bmc.arsys.api
Class AssignFieldInfo

java.lang.Object
  extended by com.bmc.arsys.api.AssignFieldInfo
All Implemented Interfaces:
Serializable, Cloneable

public class AssignFieldInfo
extends Object
implements Cloneable, Serializable

The AssignFieldInfo class identifies a form field value to assign in a Set Fields or Push Fields action. You can specify a value from any entry in any form on a particular server.

See Also:
Serialized Form

Field Summary
static int AR_CURRENCY_FLD
          AR_CURRENCY_FLD is a value from the CurrencyPart field to compare in a relational operation.
static int AR_FIELD
          AR_FIELD is a form field value to compare in a relational operation.
static int AR_STAT_HISTORY
          AR_STAT_HISTORY is a value from the Status-History core field to compare in a relational operation.
 
Constructor Summary
AssignFieldInfo()
          constructor
AssignFieldInfo(String server, String form, QualifierInfo qualifier, int tag, Object object, int noMatchOption, int multiMatchOption)
           
 
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.
 boolean equals(Object anObject, String lhsServer, String lhsForm, String rhsServer, String rhsForm)
           
 CurrencyPartInfo getCurrencyPart()
          Returns Currency part field value.
 int getFieldId()
          Returns field ID value.
 String getForm()
          Returns the name of the form containing the field value to assign.
 int getMultiMatchOption()
          Returns option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields).
 int getNoMatchOption()
          Returns integer value indicating the action to take if no entries match the search criteria.
 QualifierInfo getQualifier()
          Returns the qualification that identifies the entries to retrieve.
 String getServer()
          Returns the name of the server where the form is located.
 StatusHistoryValueIndicator getStatHistory()
          Returns Status History field value.
 int getTag()
          Returns integer value indicating the type of field value to retrieve
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setCurrencyPart(CurrencyPartInfo currencyPart)
          Sets Currency part field value.
 void setFieldId(int fieldId)
          Sets field ID value.
 void setForm(String form)
          Sets the name of the form containing the field value to assign.
 void setMultiMatchOption(int multiMatchOption)
          Sets option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields).
 void setNoMatchOption(int noMatchOption)
          Sets integer value indicating the action to take if no entries match the search criteria.
 void setQualifier(QualifierInfo qualifier)
          Sets the qualification that identifies the entries to set (optional).
 void setServer(String server)
          Sets the name of the server where the form is located.
 void setStatHistory(StatusHistoryValueIndicator statHistory)
          Sets Status History field value.
 void setTag(int tag)
          Sets integer value indicating the type of field value to set with the following constant values:
 String toString()
          Returns a string description of the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

AR_FIELD

public static final int AR_FIELD
AR_FIELD is a form field value to compare in a relational operation.

See Also:
Constant Field Values

AR_STAT_HISTORY

public static final int AR_STAT_HISTORY
AR_STAT_HISTORY is a value from the Status-History core field to compare in a relational operation.

See Also:
Constant Field Values

AR_CURRENCY_FLD

public static final int AR_CURRENCY_FLD
AR_CURRENCY_FLD is a value from the CurrencyPart field to compare in a relational operation.

See Also:
Constant Field Values
Constructor Detail

AssignFieldInfo

public AssignFieldInfo()
constructor


AssignFieldInfo

public AssignFieldInfo(String server,
                       String form,
                       QualifierInfo qualifier,
                       int tag,
                       Object object,
                       int noMatchOption,
                       int multiMatchOption)
Method Detail

getFieldId

public int getFieldId()
Returns field ID value.


setFieldId

public void setFieldId(int fieldId)
Sets field ID value.


getStatHistory

public StatusHistoryValueIndicator getStatHistory()
Returns Status History field value.


setStatHistory

public void setStatHistory(StatusHistoryValueIndicator statHistory)
Sets Status History field value.


getCurrencyPart

public CurrencyPartInfo getCurrencyPart()
Returns Currency part field value. Currency fields consist of several parts that combine to represent a complete currency value.


setCurrencyPart

public void setCurrencyPart(CurrencyPartInfo currencyPart)
Sets Currency part field value. Currency fields consist of several parts that combine to represent a complete currency value.


getServer

public String getServer()
Returns the name of the server where the form is located.


setServer

public void setServer(String server)
Sets the name of the server where the form is located.


getForm

public String getForm()
Returns the name of the form containing the field value to assign.


setForm

public void setForm(String form)
Sets the name of the form containing the field value to assign.
  • For filters and escalations, specify @ to set the value from the current transaction.
  • For active links, specify * to set the value from the current window.


  • getQualifier

    public QualifierInfo getQualifier()
    Returns the qualification that identifies the entries to retrieve.


    setQualifier

    public void setQualifier(QualifierInfo qualifier)
    Sets the qualification that identifies the entries to set (optional).


    getTag

    public int getTag()
    Returns integer value indicating the type of field value to retrieve


    setTag

    public void setTag(int tag)
    Sets integer value indicating the type of field value to set with the following constant values:

    Parameters:
    tag - Use these values:AR_FIELD, AR_STAT_HISTORY, AR_CURRENCY_FLD

    getNoMatchOption

    public int getNoMatchOption()
    Returns integer value indicating the action to take if no entries match the search criteria.


    setNoMatchOption

    public void setNoMatchOption(int noMatchOption)
    Sets integer value indicating the action to take if no entries match the search criteria. Use the following constant values:

    Parameters:
    noMatchOption - Use these values:

    getMultiMatchOption

    public int getMultiMatchOption()
    Returns option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields).


    setMultiMatchOption

    public void setMultiMatchOption(int multiMatchOption)
    Sets option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields).

    Parameters:
    multiMatchOption - Use the following constant values:

    clone

    public Object clone()
                 throws CloneNotSupportedException
    Clone implementation that returns an Object with data cloned from self

    Overrides:
    clone in class Object
    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 Object
    Parameters:
    obj - the object that we are comparing to
    Returns:
    returns a boolean that tells if the two objects equal

    equals

    public boolean equals(Object anObject,
                          String lhsServer,
                          String lhsForm,
                          String rhsServer,
                          String rhsForm)

    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 Object
    Returns:
    returns the hash code for this instance

    toString

    public String toString()
    Returns a string description of the object.

    Overrides:
    toString in class Object

    AR System Java API

    © Copyright 2006, 2007 BMC Software, Inc.