wt.fc.requireddata
Class AdHocForeignKeyLinkQueryData

java.lang.Object
  wt.fc.requireddata.LinkQueryData
      wt.fc.requireddata.AdHocForeignKeyLinkQueryData

public final class AdHocForeignKeyLinkQueryData

extends LinkQueryData

Data carrier for ad hoc foreign key queries, i.e. queries for relationships that are not modeled as BinaryLink or ForeignKeyLink. E.g., this data carrier would support Iterated class branchId validation where the Iterated branchId is an "adhoc" foreign key to the ControlBranch primary key.

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
private String	foreignKeyAttribute
private boolean	includeDescendants
private String	parentAttribute
private Class	parentClass
private static String	RESOURCE

Fields inherited from class wt.fc.requireddata.LinkQueryData

Constructor Summary

private

AdHocForeignKeyLinkQueryData()

Method Summary

private void	foreignKeyAttributeValidate(String a_ForeignKeyAttribute)
String	getForeignKeyAttribute() Gets the value of the attribute: foreignKeyAttribute.
Class	getForeignKeyClass() Returns the Class that plays the foreign key role.
String	getParentAttribute() Gets the value of the attribute: parentAttribute.
Class	getParentClass() Gets the value of the attribute: parentClass.
long[]	getParentObjectIds() Returns ids for the parent objects.
boolean	isIncludeDescendants() Gets the value of the attribute: includeDescendants.
static AdHocForeignKeyLinkQueryData	newInstance(Class foreignKeyClass, String a_foreignKeyAttribute, Class a_parentClass, String a_parentAttribute, long[] parentObjectIds, boolean includeDescendants) Supported API: false
static AdHocForeignKeyLinkQueryData	newInstance(Class foreignKeyClass, String a_foreignKeyAttribute, Class a_parentClass, String a_parentAttribute, Long[] parentObjectIds, boolean includeDescendants) Supported API: false
private void	parentAttributeValidate(String a_ParentAttribute)
void	setForeignKeyAttribute(String a_ForeignKeyAttribute) Sets the value of the attribute: foreignKeyAttribute.
void	setForeignKeyClass(Class foreignKeyClass) Supported API: false
void	setIncludeDescendants(boolean a_IncludeDescendants) Sets the value of the attribute: includeDescendants.
void	setParentAttribute(String a_ParentAttribute) Sets the value of the attribute: parentAttribute.
void	setParentClass(Class a_ParentClass) Sets the value of the attribute: parentClass.
void	setParentObjectIds(long[] parentObjectIds) Supported API: false
String	toString()

Methods inherited from class wt.fc.requireddata.LinkQueryData

getIdString, getLinkClass, getRoleAIds, getRoleBIds, newInstance, newInstance, setLinkClass, setRoleAIds, setRoleBIds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

foreignKeyAttribute

private String foreignKeyAttribute

parentClass

private Class parentClass

parentAttribute

private String parentAttribute

includeDescendants

private boolean includeDescendants

Constructor Detail

AdHocForeignKeyLinkQueryData

private AdHocForeignKeyLinkQueryData()

Method Detail

getForeignKeyAttribute

public String getForeignKeyAttribute()

Gets the value of the attribute: foreignKeyAttribute.

Supported API: false

Returns:

String

setForeignKeyAttribute

public void setForeignKeyAttribute(String a_ForeignKeyAttribute)
                            throws WTPropertyVetoException

Sets the value of the attribute: foreignKeyAttribute.

Supported API: false

Parameters:

a_ForeignKeyAttribute -

Throws:

WTPropertyVetoException

foreignKeyAttributeValidate

private void foreignKeyAttributeValidate(String a_ForeignKeyAttribute)
                                  throws WTPropertyVetoException

Parameters:

a_ForeignKeyAttribute -

Throws:

WTPropertyVetoException

getParentClass

public Class getParentClass()

Gets the value of the attribute: parentClass.

Supported API: false

Returns:

Class

setParentClass

public void setParentClass(Class a_ParentClass)
                    throws WTPropertyVetoException

Sets the value of the attribute: parentClass.

Supported API: false

Parameters:

a_ParentClass -

Throws:

WTPropertyVetoException

getParentAttribute

public String getParentAttribute()

Gets the value of the attribute: parentAttribute.

Supported API: false

Returns:

String

setParentAttribute

public void setParentAttribute(String a_ParentAttribute)
                        throws WTPropertyVetoException

Sets the value of the attribute: parentAttribute.

Supported API: false

Parameters:

a_ParentAttribute -

Throws:

WTPropertyVetoException

parentAttributeValidate

private void parentAttributeValidate(String a_ParentAttribute)
                              throws WTPropertyVetoException

Parameters:

a_ParentAttribute -

Throws:

WTPropertyVetoException

isIncludeDescendants

public boolean isIncludeDescendants()

Gets the value of the attribute: includeDescendants.

Supported API: false

Returns:

boolean

setIncludeDescendants

public void setIncludeDescendants(boolean a_IncludeDescendants)
                           throws WTPropertyVetoException

Sets the value of the attribute: includeDescendants.

Supported API: false

Parameters:

a_IncludeDescendants -

Throws:

WTPropertyVetoException

newInstance

public static AdHocForeignKeyLinkQueryData newInstance(Class foreignKeyClass,
                                                       String a_foreignKeyAttribute,
                                                       Class a_parentClass,
                                                       String a_parentAttribute,
                                                       long[] parentObjectIds,
                                                       boolean includeDescendants)

Supported API: false

Parameters:

foreignKeyClass -

a_foreignKeyAttribute -

a_parentClass -

a_parentAttribute -

parentObjectIds -

includeDescendants -

Returns:

AdHocForeignKeyLinkQueryData

newInstance

public static AdHocForeignKeyLinkQueryData newInstance(Class foreignKeyClass,
                                                       String a_foreignKeyAttribute,
                                                       Class a_parentClass,
                                                       String a_parentAttribute,
                                                       Long[] parentObjectIds,
                                                       boolean includeDescendants)

Supported API: false

Parameters:

foreignKeyClass -

a_foreignKeyAttribute -

a_parentClass -

a_parentAttribute -

parentObjectIds -

includeDescendants -

Returns:

AdHocForeignKeyLinkQueryData

getParentObjectIds

public long[] getParentObjectIds()

Returns ids for the parent objects. E.g., in the ControlBranch/Iterateds example returns the ids for the Iterated objects.

Supported API: false

Returns:

long[]

getForeignKeyClass

public Class getForeignKeyClass()

Returns the Class that plays the foreign key role. E.g., returns ControlBranch in the ControlBranch/Iterated example.

Supported API: false

Returns:

Class

setForeignKeyClass

public void setForeignKeyClass(Class foreignKeyClass)
                        throws WTPropertyVetoException

Supported API: false

Parameters:

foreignKeyClass -

Throws:

WTPropertyVetoException

setParentObjectIds

public void setParentObjectIds(long[] parentObjectIds)
                        throws WTPropertyVetoException

Supported API: false

Parameters:

parentObjectIds -

Throws:

WTPropertyVetoException

toString

public String toString()

Overrides:

toString in class LinkQueryData