com.remedy.arsys.api
Class JoinSchemaInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.CompoundSchemaInfo
        |
        +--com.remedy.arsys.api.JoinSchemaInfo

All Implemented Interfaces:

java.lang.Cloneable

public class JoinSchemaInfo

extends CompoundSchemaInfo

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

Fields inherited from class com.remedy.arsys.api.CompoundSchemaInfo

m_type

Constructor Summary

JoinSchemaInfo(NameID schemaA, NameID schemaB, QualifierInfo qualification, int joinOption)
Constructs a JoinSchema object.

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
int	getJoinOption() Returns the join type and the action to take when users modify entries.
QualifierInfo	getJoinQualification() Returns criteria for joining schemas.
NameID	getMemberA() Returns name of member schema A.
NameID	getMemberB() Returns name of member schema B.

Methods inherited from class com.remedy.arsys.api.CompoundSchemaInfo

equals, getType, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JoinSchemaInfo

public JoinSchemaInfo(NameID schemaA,
                      NameID schemaB,
                      QualifierInfo qualification,
                      int joinOption)

Constructs a JoinSchema object.

Parameters:

schemaA - The name of a member schema participating in the join (can also be a join schema by itself)

schemaB - The name of a member schema participating in the join (can also be a join schema by itself)

qualification - The criteria for joining the two schemas

joinOption - The join option. Values can be as follows:

• 0: Inner Join
• 1: Outer Join

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

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

Overrides:

clone in class CompoundSchemaInfo

getMemberA

public NameID getMemberA()

Returns name of member schema A.

getMemberB

public NameID getMemberB()

Returns name of member schema B.

getJoinQualification

public QualifierInfo getJoinQualification()

Returns criteria for joining schemas.

getJoinOption

public int getJoinOption()

Returns the join type and the action to take when users modify entries. The following constants are used:

Parameters:

AR_JOIN_OPTION_NONE - Constants.AR_JOIN_OPTION_NONE
Inner join

AR_JOIN_OPTION_OUTER - Constants.AR_JOIN_OPTION_OUTER
Outer join

AR_JOIN_SETOPTION_NONE - Constants.AR_JOIN_SETOPTION_NONE
Allow users to update fields used in the join criteria.

AR_JOIN_SETOPTION_REF - Constants.AR_JOIN_SETOPTION_REF
Do not allow users to update fields used in the join criteria