public interface IDfRelationType extends IDfPersistentObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHILD
CHILD security means the permissions to create, modify, or drop instances
of a relationship depend on the object type of the child.
|
static int |
COPY_CHILD
Create new copies of referenced children when parent document is copied.
|
static java.lang.String |
NONE
NONE security means that any user can create, modify, or drop relationships
of that kind.
|
static java.lang.String |
PARENT
PARENT security means the permissions to create, modify, or drop instances
of a relationship depend on the object type of the parent.
|
static int |
REFERENCE_CHILD
Reference existing children when parent document is copied.
|
static java.lang.String |
SYSTEM
SYSTEM security means that only superusers or system administrators can
directly create, modify, or drop instances of the relationship.
|
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getChildType()
Returns the object type of a valid child object in the
relationship.
|
java.lang.String |
getControllingKind()
Returns the controlling kind attribute defined for the relation of this type.
|
int |
getCopyBehavior()
Returns the copy behavior defined for the relation of this type.
|
java.lang.String |
getDescription()
Returns the user defined description of the relationship.
|
java.lang.String |
getParentType()
Returns the object type of a valid parent object in the
relationship.
|
boolean |
getPermanentLink()
Indicates if you want to maintain the relationship across versions of
the parent object.
|
java.lang.String |
getRelationName()
Returns the value of the relation_name attribute.
|
java.lang.String |
getSecurityType()
Returns the security applied to objects of type dm_relation_type
whose relation_name attribute value matches the
relation_name attribute for the dm_relation_type object.
|
void |
setChildType(java.lang.String child)
Sets the object type of a valid child object in the
relationship.
|
void |
setControllingKind(java.lang.String val)
Sets the controlling kind attribute defined for the relation of this type.
|
void |
setCopyBehavior(int val)
Sets the copy behavior defined for the relation of this type.
|
void |
setDescription(java.lang.String desc)
Sets the user defined description of the relationship.
|
void |
setParentType(java.lang.String parent)
Sets the object type of a valid parent object in the
relationship.
|
void |
setPermanentLink(boolean val)
Indicates if you want to maintain the relationship across
versions of the parent object.
|
void |
setRelationName(java.lang.String rName)
Sets the value of the relation_name attribute.
|
void |
setSecurityType(java.lang.String sType)
Sets the security applied to objects of type dm_relation
whose relation_name attribute value matches the
relation_name attribute for the dm_relation_type object.
|
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
static final int REFERENCE_CHILD
static final int COPY_CHILD
static final java.lang.String SYSTEM
static final java.lang.String PARENT
static final java.lang.String CHILD
static final java.lang.String NONE
java.lang.String getRelationName() throws DfException
DfException
- if a server error occurs.setRelationName(java.lang.String)
java.lang.String getSecurityType() throws DfException
DfException
- if a server error occurs.setSecurityType(java.lang.String)
java.lang.String getParentType() throws DfException
DfException
- if a server error occurs.setParentType(java.lang.String)
java.lang.String getChildType() throws DfException
DfException
- if a server error occurs.setChildType(java.lang.String)
java.lang.String getDescription() throws DfException
DfException
- if a server error occurs.setDescription(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 server does not support this attribute (pre 5.3)setPermanentLink(boolean)
int getCopyBehavior() throws DfException
The copy behavior defined for a relation determines how the
child is handled when the parent object is copied.
Copy behavior is used only when
getPermanentLink () is true
For more information about copy behavior, refer to Server Fundamentals.
Value Meaning REFERENCE_CHILD Reference the existing component document. COPY_CHILD Create a new copy of the component document.
DfException
- if server does not support this attribute (pre 5.3)setCopyBehavior(int)
java.lang.String getControllingKind() throws DfException
The controlling kind attribute indicates whether the relation type is created by external users or the application. If the relation type is created by external user, then the user can create and destroy instances of dm_relation based on the relation type. For more information about controlling kind, refer to Server Fundamentals.
DfException
- if server does not support this attribute (pre 6.0)setControllingKind(java.lang.String)
void setRelationName(java.lang.String rName) throws DfException
rName
- the name of the relation.DfException
- if a server error occurs.getRelationName()
void setSecurityType(java.lang.String sType) throws DfException
sType
- the security applied to the object. Valid
values are "SYSTEM", "PARENT", "CHILD" and "NONE".DfException
- if a server error occurs.getSecurityType()
void setParentType(java.lang.String parent) throws DfException
parent
- the object type of a valid parent object.DfException
- if a server error occurs.getParentType()
void setChildType(java.lang.String child) throws DfException
child
- the object type of a valid child object.DfException
- if a server error occurs.getChildType()
void setDescription(java.lang.String desc) throws DfException
desc
- the description of the relationship.DfException
- if a server error occurs.getDescription()
void setPermanentLink(boolean val) throws DfException
setPermanentLink
to true
.val
- value of the permanent_link flag.DfException
- if server does not support this attribute (pre 5.3)getPermanentLink()
void setCopyBehavior(int val) throws DfException
The copy behavior defined for a relation determines how the
child is handled when the parent object is copied.
Copy behavior is used only when
getPermanentLink () is true
For more information about copy behavior, refer to Server Fundamentals.
val
- value indicating the copy behavior for the relation of this type.
Valid values and their meanings are:
Value Meaning REFERENCE_CHILD Reference the existing component document. COPY_CHILD Create a new copy of the component document.
DfException
- if server does not support this attribute (pre 5.3)getCopyBehavior()
void setControllingKind(java.lang.String val) throws DfException
The controlling kind attribute indicates whether the relation type is created by external users or the application. If the relation type is created by external user, then the user can create and destroy instances of dm_relation based on the relation type. For more information about controlling kind, refer to Server Fundamentals.
val
- value indicating the controlling kind for the relation of this type.DfException
- if server does not support this attribute (pre 6.0)getControllingKind()
Copyright 1994-2023 OpenText Corporation. All rights reserved.