AR System Java API

com.bmc.arsys.api
Class PushFieldsAction

java.lang.Object
  extended by com.bmc.arsys.api.Action
      extended by com.bmc.arsys.api.PushFieldsAction
All Implemented Interfaces:
ActiveLinkAction, FilterAction, Serializable, Cloneable

public class PushFieldsAction
extends Action
implements ActiveLinkAction, FilterAction, Cloneable, Serializable

The PushFieldsAction class is used to change the values of fields in existing entries or create a new entry during a transaction.

See Also:
Serialized Form

Constructor Summary
PushFieldsAction()
           
PushFieldsAction(String sampleForm, String sampleServer, List<PushFieldsInfo> pushFieldsList)
           
 
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)
           
 int getMultiMatchOption()
           
 int getNoMatchOption()
           
 List<PushFieldsInfo> getPushFieldsList()
          Returns information about Push Fields filter action.
 QualifierInfo getPushIfQualification()
           
 String getPushIfQualificationAsString()
           
 String getPushToForm()
           
 String getPushToServer()
           
 String getSampleForm()
          Returns name of the sample form.
 String getSampleServer()
          Returns name of the sample server.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 boolean isAssignmentByMatchingIds()
           
 boolean isAssignmentToDefaults()
           
 void setAssignmentByMatchingIds(boolean byMatchingIds)
          sets the assignments to be by matching ids
 void setAssignmentToDefaults(boolean isSetToDefaults)
           
 void setMultiMatchOption(int multiMatchOption)
           
 void setNoMatchOption(int noMatchOption)
           
 void setPushFieldsList(List<PushFieldsInfo> pushFieldsList)
          Assigns values for Push Fields filter action.
 void setPushIfQualification(QualifierInfo pushIfQualification)
           
 void setPushIfQualificationAsString(String pushIfQualificationAsString)
           
 void setPushToForm(String pushToForm)
           
 void setPushToServer(String pushToServer)
           
 void setSampleForm(String sampleForm)
          Sets the name of the sample form.
 void setSampleServer(String sampleServer)
          Sets the name of the sample server.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.Action
getActionType
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PushFieldsAction

public PushFieldsAction()

PushFieldsAction

public PushFieldsAction(String sampleForm,
                        String sampleServer,
                        List<PushFieldsInfo> pushFieldsList)
Method Detail

getSampleForm

public String getSampleForm()
Returns name of the sample form.


setSampleForm

public void setSampleForm(String sampleForm)
Sets the name of the sample form.


getSampleServer

public String getSampleServer()
Returns name of the sample server.


setSampleServer

public void setSampleServer(String sampleServer)
Sets the name of the sample server.


getPushFieldsList

public List<PushFieldsInfo> getPushFieldsList()
Returns information about Push Fields filter action.


setPushFieldsList

public void setPushFieldsList(List<PushFieldsInfo> pushFieldsList)
Assigns values for Push Fields filter action.


isAssignmentByMatchingIds

public boolean isAssignmentByMatchingIds()
Returns:
the byMatchingIds

setAssignmentByMatchingIds

public void setAssignmentByMatchingIds(boolean byMatchingIds)
sets the assignments to be by matching ids

Parameters:
byMatchingIds - whether to set by matching ids or not (true/false)

isAssignmentToDefaults

public boolean isAssignmentToDefaults()
Returns:
the isSetToDefaults

setAssignmentToDefaults

public void setAssignmentToDefaults(boolean isSetToDefaults)
Parameters:
isSetToDefaults - the isSetToDefaults to set

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

equals

public boolean equals(Object anObject,
                      String lhsServer,
                      String lhsForm,
                      String rhsServer,
                      String rhsForm)
Overrides:
equals in class Action

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

getMultiMatchOption

public int getMultiMatchOption()
Returns:
the multiMatchOption

setMultiMatchOption

public void setMultiMatchOption(int multiMatchOption)
Parameters:
multiMatchOption - the multiMatchOption to set

getNoMatchOption

public int getNoMatchOption()
Returns:
the noMatchOption

setNoMatchOption

public void setNoMatchOption(int noMatchOption)
Parameters:
noMatchOption - the noMatchOption to set

getPushIfQualification

public QualifierInfo getPushIfQualification()
Returns:
the pushIfQualification

setPushIfQualification

public void setPushIfQualification(QualifierInfo pushIfQualification)
Parameters:
pushIfQualification - the pushIfQualification to set

getPushIfQualificationAsString

public String getPushIfQualificationAsString()
Returns:
the pushIfQualificationAsString

setPushIfQualificationAsString

public void setPushIfQualificationAsString(String pushIfQualificationAsString)
Parameters:
pushIfQualificationAsString - the pushIfQualificationAsString to set

getPushToForm

public String getPushToForm()
Returns:
the pushToForm

setPushToForm

public void setPushToForm(String pushToForm)
Parameters:
pushToForm - the pushToForm to set

getPushToServer

public String getPushToServer()
Returns:
the pushToServer

setPushToServer

public void setPushToServer(String pushToServer)
Parameters:
pushToServer - the pushToServer to set

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.