public interface IDfRelation extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
IDfId |
getChildId()
Returns the object ID of the child object in the relationship.
|
java.lang.String |
getChildLabel()
Returns the version label of the child object in the relationship.
|
java.lang.String |
getDescription()
Not system defined.Provided for user convenience.
|
IDfTime |
getEffectiveDate()
Not system defined.
|
IDfTime |
getExpirationDate()
Not system defined.
|
int |
getOrderNumber()
Not system defined.
|
IDfId |
getParentId()
Returns the object ID of the parent object.
|
boolean |
getPermanentLink()
Deprecated.
As of DFC 5.3, replaced by IDfRelationType.getPermanentLink()
|
java.lang.String |
getRelationName()
Returns the attribute value of relation_name.
|
void |
setChildId(IDfId child)
Sets the ID of the object that is the "child" in the relationship.
|
void |
setChildLabel(java.lang.String label)
Sets the version label of the child in the relationship.
|
void |
setDescription(java.lang.String desc)
Not system defined.
|
void |
setEffectiveDate(IDfTime date)
Not system defined.
|
void |
setExpirationDate(IDfTime date)
Not system defined.
|
void |
setOrderNumber(int no)
Not system defined.
|
void |
setParentId(IDfId parent)
Sets the ID of the object that is the "parent" in the relationship.
|
void |
setPermanentLink(boolean val)
Deprecated.
As of DFC 5.3, replaced by IDfRelationType.setPermanentLink()
|
void |
setRelationName(java.lang.String rName)
Sets the relation_name attribute.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
java.lang.String getRelationName() throws DfException
DfException
- if a server error occurs.IDfId getParentId() throws DfException
DfException
- if server error occurs.setParentId(com.documentum.fc.common.IDfId)
IDfId getChildId() throws DfException
DfException
- if server error occurs.setChildId(com.documentum.fc.common.IDfId)
java.lang.String getChildLabel() throws DfException
DfException
- if a server error occurs.setChildLabel(java.lang.String)
boolean getPermanentLink() throws DfException
By default, relationships are not maintained across versions. However, if
you want the relationship to be maintained across versions when the
parent object is versioned, set permanent_link via setPermanentLink
to true
.
false
if a relationship does not exist.DfException
- if a server error occurs.setPermanentLink(boolean)
int getOrderNumber() throws DfException
DfException
- if a server error occurs.setOrderNumber(int)
IDfTime getEffectiveDate() throws DfException
DfException
- if a server error occurs.setEffectiveDate(com.documentum.fc.common.IDfTime)
IDfTime getExpirationDate() throws DfException
DfException
- if a server error occurs.setExpirationDate(com.documentum.fc.common.IDfTime)
java.lang.String getDescription() throws DfException
DfException
- if a server error occurs.setDescription(java.lang.String)
void setRelationName(java.lang.String rName) throws DfException
rName
- name of the relation.DfException
- if a server error occurs.getRelationName()
void setParentId(IDfId parent) throws DfException
parent
- ID of the parent.DfException
- if a server error occurs.getParentId()
void setChildId(IDfId child) throws DfException
child
- ID of the child.DfException
- if a server error occurs.getChildId()
void setChildLabel(java.lang.String label) throws DfException
label
- label of the child.DfException
- if a server error occurs.setChildLabel(java.lang.String)
void setPermanentLink(boolean val) throws DfException
setPermanentLink
to true
.val
- value of the permanent_link flag.DfException
- if a server error occurs.getPermanentLink()
void setOrderNumber(int no) throws DfException
no
- order number.DfException
- if a server error occurs.getOrderNumber()
void setEffectiveDate(IDfTime date) throws DfException
date
- effective date.DfException
- if a server error occurs.getEffectiveDate()
void setExpirationDate(IDfTime date) throws DfException
date
- expiration date.DfException
- if a server error occurs.getExpirationDate()
void setDescription(java.lang.String desc) throws DfException
desc
- description.DfException
- if a server error occurs.getDescription()
Copyright 1994-2023 OpenText Corporation. All rights reserved.