Package org.adempiere.model

Class MRelationType

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_RelationType

org.adempiere.model.MRelationType

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, IZoomProvider, I_AD_RelationType, I_Persistent, Evaluatee

public class MRelationType
extends X_AD_RelationType
implements IZoomProvider

Extended model class for AD_RelationType.
Formal definition for a set of data record pairs.

Author:

Tobias Schoeneberg, www.metas.de - FR [ 2897194 ] Advanced Zoom and RelationTypes

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
int	destinationRefId
protected static final String	SQL	Selection for those relation types whose AD_Reference(s) might match a given PO.
protected static final String	SQL_WINDOW_NAME
protected static final String	SQL_WINDOW_NAME_TRL

Fields inherited from class org.compiere.model.X_AD_RelationType

ENTITYTYPE_AD_Reference_ID, ROLE_SOURCE_AD_Reference_ID, ROLE_SOURCE_Invoice, ROLE_SOURCE_Order, ROLE_TARGET_AD_Reference_ID, ROLE_TARGET_Invoice, ROLE_TARGET_Order, TYPE_AD_Reference_ID, TYPE_Explicit, TYPE_Implicit

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_RelationType

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Reference_Source_ID, COLUMNNAME_AD_Reference_Target_ID, COLUMNNAME_AD_RelationType_ID, COLUMNNAME_AD_RelationType_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_Description, COLUMNNAME_EntityType, COLUMNNAME_IsActive, COLUMNNAME_IsDirected, COLUMNNAME_Name, COLUMNNAME_Role_Source, COLUMNNAME_Role_Target, COLUMNNAME_Type, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MRelationType(Properties ctx, int AD_RelationType_ID, String trxName)
MRelationType(Properties ctx, int AD_RelationType_ID, String trxName, String... virtualColumns)
MRelationType(Properties ctx, String AD_RelationType_UU, String trxName)	UUID based Constructor
MRelationType(Properties ctx, ResultSet rs, String trxName)

Method Summary

Modifier and Type	Method	Description
void	checkDestinationRefId()	throw exception if destination reference is not valid
static String	parseWhereClause(PO po, String where)
String	retrieveDestinationKeyColName()
String	retrieveDestinationTableName()
static MRefTable	retrieveRefTable(Properties ctx, int referenceId, String trxName)
static List<MRelationType>	retrieveTypes(PO po, int windowId)	Returns the types that define a relation which contains the given PO. Explicit types are returned even if they don't actually contain the given PO.
int	retrieveWindowID(PO po, MRefTable refTable)
List<ZoomInfoFactory.ZoomInfo>	retrieveZoomInfos(PO po)	Discover zoom targets for po
static List<ZoomInfoFactory.ZoomInfo>	retrieveZoomInfos(PO po, int windowID)
String	toString()	String representation
protected static boolean	whereClauseMatches(PO po, String where)

Methods inherited from class org.compiere.model.X_AD_RelationType

get_AccessLevel, getAD_Reference_Source, getAD_Reference_Source_ID, getAD_Reference_Target, getAD_Reference_Target_ID, getAD_RelationType_ID, getAD_RelationType_UU, getDescription, getEntityType, getKeyNamePair, getName, getRole_Source, getRole_Target, getType, initPO, isDirected, setAD_Reference_Source_ID, setAD_Reference_Target_ID, setAD_RelationType_ID, setAD_RelationType_UU, setDescription, setEntityType, setIsDirected, setName, setRole_Source, setRole_Target, setType

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_RelationType

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Details

SQL

protected static final String SQL

Selection for those relation types whose AD_Reference(s) might match a given PO. Only evaluates the table and key column of the reference's AD_Ref_Table entries.

Warning: Doesn't support POs with more or less than one key column.

See Also:

• Constant Field Values

SQL_WINDOW_NAME

protected static final String SQL_WINDOW_NAME

See Also:

• Constant Field Values

SQL_WINDOW_NAME_TRL

protected static final String SQL_WINDOW_NAME_TRL

See Also:

• Constant Field Values

destinationRefId

public int destinationRefId

Constructor Details

MRelationType

public MRelationType(Properties ctx,
 String AD_RelationType_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_RelationType_UU - UUID key

trxName - Transaction

MRelationType

public MRelationType(Properties ctx,
 int AD_RelationType_ID,
 String trxName)

Parameters:

ctx -

AD_RelationType_ID -

trxName -

MRelationType

public MRelationType(Properties ctx,
 ResultSet rs,
 String trxName)

Parameters:

ctx -

rs -

trxName -

MRelationType

public MRelationType(Properties ctx,
 int AD_RelationType_ID,
 String trxName,
 String... virtualColumns)

Parameters:

ctx -

AD_RelationType_ID -

trxName -

virtualColumns -

Method Details

retrieveTypes

public static List<MRelationType> retrieveTypes(PO po,
 int windowId)

Returns the types that define a relation which contains the given PO.
Explicit types are returned even if they don't actually contain the given PO.

Parameters:

po -

Returns:

matching relation types

retrieveZoomInfos

public static List<ZoomInfoFactory.ZoomInfo> retrieveZoomInfos(PO po,
 int windowID)

Parameters:

po -

windowID -

Returns:

zoom info records from matching relation types

whereClauseMatches

protected static boolean whereClauseMatches(PO po,
 String where)

Parameters:

po -

where -

Returns:

true if where is empty or match found in DB

parseWhereClause

public static String parseWhereClause(PO po,
 String where)

Parameters:

po -

where -

Returns:

parsed where clause

checkDestinationRefId

public void checkDestinationRefId()

throw exception if destination reference is not valid

retrieveZoomInfos

public List<ZoomInfoFactory.ZoomInfo> retrieveZoomInfos(PO po)

Description copied from interface: IZoomProvider

Discover zoom targets for po

Specified by:

retrieveZoomInfos in interface IZoomProvider

Parameters:

po -

Returns:

zoom info records from destination reference

retrieveWindowID

public int retrieveWindowID(PO po,
 MRefTable refTable)

Parameters:

po -

refTable -

Returns:

AD_Window_ID

retrieveRefTable

public static MRefTable retrieveRefTable(Properties ctx,
 int referenceId,
 String trxName)

Parameters:

ctx -

referenceId -

trxName -

Returns:

MRefTable

retrieveDestinationTableName

public String retrieveDestinationTableName()

Returns:

table name of destination reference

retrieveDestinationKeyColName

public String retrieveDestinationKeyColName()

Returns:

key column name of destination reference

toString

public String toString()

Description copied from class: PO

String representation

Overrides:

toString in class X_AD_RelationType

Returns:

String representation