com.bmc.arsys.api
Class JoinFieldMapping

java.lang.Object
  com.bmc.arsys.api.FieldMapping
      com.bmc.arsys.api.JoinFieldMapping

All Implemented Interfaces:

Serializable, Cloneable

public class JoinFieldMapping
extends FieldMapping
implements Cloneable, Serializable

The JoinFieldMapping class contains the index of the base form and the ID of the field to map to this field.

See Also:

Serialized Form

Constructor Summary

JoinFieldMapping()

JoinFieldMapping(int index, int fieldId)

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	getFieldID() Returns the internal ID associated with the field.
int	getIndex() Returns the member form to which the field maps.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setFieldID(int id) Sets the internal ID associated with the field.
void	setIndex(int index) Sets the member form to which the field maps.
String	toString() Returns a string description of the object.

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

createInstance, getMappingType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JoinFieldMapping

public JoinFieldMapping()

JoinFieldMapping

public JoinFieldMapping(int index,
                        int fieldId)

Method Detail

getIndex

public int getIndex()

Returns the member form to which the field maps.

getFieldID

public int getFieldID()

Returns the internal ID associated with the field.

setIndex

public void setIndex(int index)

Sets the member form to which the field maps. Possible constant values include the following:

• AR_FIELD_MAPPING_PRIMARY
  This value represents the primary form in a join.
• AR_FIELD_MAPPING_SECONDARY
  This value represents the secondary form in a join.

setFieldID

public void setFieldID(int id)

Sets the internal ID associated with the field.

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class FieldMapping

Throws:

CloneNotSupportedException

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class FieldMapping

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 FieldMapping

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 FieldMapping

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal