AR System Java API

com.bmc.arsys.api
Class JoinForm

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
      extended by com.bmc.arsys.api.Form
          extended by com.bmc.arsys.api.JoinForm
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable

public class JoinForm
extends Form
implements Cloneable, Serializable

The JoinForm class represents a type of "compound form" consisting of a join between two or more AR System forms. It contains the names of the two member forms (either of which could also be join forms), the criteria for joining them, and a bitmask indicating various join options.

See Also:
Serialized Form

Constructor Summary
JoinForm()
           
JoinForm(String formA, String formB, QualifierInfo qualification, int joinOption)
          Constructs a JoinForm object.
 
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 getJoinOption()
          Returns the join type and the action to take when users modify entries.
 QualifierInfo getJoinQualification()
          Returns criteria for joining forms.
 String getMemberA()
          Returns name of member form A.
 String getMemberB()
          Returns name of member form B.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setJoinOption(int joinOption)
           
 void setJoinQualification(QualifierInfo joinQualification)
           
 void setMemberA(String memberA)
           
 void setMemberB(String memberB)
           
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.Form
getAdminGrpList, getArchiveInfo, getAssignedGroup, getAuditInfo, getDefaultVUI, getEntryListFieldInfo, getFormType, getIndexInfo, getKey, getProperties, getSortInfo, setAdminGrpList, setArchiveInfo, setAuditInfo, setDefaultVUI, setDeleteOption, setEntryListFieldInfo, setIndexInfo, setKey, setPermissions, setProperties, setSortInfo
 
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
 

Constructor Detail

JoinForm

public JoinForm()

JoinForm

public JoinForm(String formA,
                String formB,
                QualifierInfo qualification,
                int joinOption)
Constructs a JoinForm object.

Parameters:
formA - The name of a member form participating in the join (can also be a join form by itself)
formB - The name of a member form participating in the join (can also be a join form by itself)
qualification - The criteria for joining the two forms
joinOption - The join option. Values can be as follows:
  • 0: Inner Join
  • 1: Outer Join
Method Detail

clone

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

Overrides:
clone in class Form
Throws:
CloneNotSupportedException

getMemberA

public String getMemberA()
Returns name of member form A.


getMemberB

public String getMemberB()
Returns name of member form B.


getJoinQualification

public QualifierInfo getJoinQualification()
Returns criteria for joining forms.


getJoinOption

public int getJoinOption()
Returns the join type and the action to take when users modify entries. The following constants are used:


toString

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

Overrides:
toString in class Form

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

setJoinOption

public void setJoinOption(int joinOption)

setJoinQualification

public void setJoinQualification(QualifierInfo joinQualification)

setMemberA

public void setMemberA(String memberA)

setMemberB

public void setMemberB(String memberB)

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.