public interface IDfAssembly extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
IDfId |
getBookId()
Returns the object ID of the top-most containing virtual document.
|
IDfId |
getComponentChronicleId()
Returns the chronicle ID of the component document.
|
IDfId |
getComponentId()
Returns the object ID of the component represented by the assembly object.
|
java.lang.String |
getContainDescription() |
java.lang.String |
getContainType() |
int |
getDepth()
Returns the depth of this component within the top-most virtual document.
|
double |
getOrderNumber()
Returns the order number of the component within the top-most virtual document.
|
IDfId |
getParentId()
Returns the object ID of the document that directly contains the virtual document described by the
assembly to which this assembly object belongs.
|
void |
setBookId(IDfId parentObjectId)
Sets the book_id attribute of the assembly object.
|
void |
setComponentChronicleId(IDfId chronId)
Sets the component_chron_id attribute of the assembly object.
|
void |
setComponentId(IDfId objectId)
Sets the component_id attribute of the assembly object.
|
void |
setContainDescription(java.lang.String containDesc) |
void |
setContainType(java.lang.String containType) |
void |
setDepth(int depth)
Sets the depth_no attribute of the assembly object.
|
void |
setOrderNumber(double orderNumber)
Sets the order_no attribute of the assembly object.
|
void |
setParentId(IDfId parentObjectId)
Sets the parent_id attribute of the assembly 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
IDfId getBookId() throws DfException
A virtual document is a hierarchy of documents. This method returns the virtual document that is at the top of the hierarchy that contains the virtual document represented by this assembly.
For more information about virtual document structure and assemblies, refer to Server Fundamentals.
DfException
- if the server returns an errorvoid setBookId(IDfId parentObjectId) throws DfException
This attribute records the object ID of the top-most virtual document that contains the virtual document represented by the assembly in which this assembly object participates.
For more information about virtual document structure and assemblies, refer to Server Fundamentals.
parentObjectId
- An IDfId object that contains the object ID of the top-most virtual document.DfException
- if the server returns an errorIDfId getParentId() throws DfException
A virtual document can contain both simple and virtual documents, nested to any level. An assembly is a group of assembly objects that describe the components of a virtual document. If the assembly describes a virtual document that is nested in the hierarchy of another virtual document, this method returns the object ID of the document in the hierarchy that directly contains the virtual document described by the assembly.
If the assembly describes the top-most virtual document in the hierarchy, this method returns the object ID of the top-most virtual document.
For more information about virtual document structure and assemblies, refer to Server Fundamentals.
DfException
- if the server returns an errorvoid setParentId(IDfId parentObjectId) throws DfException
This attribute records the object ID of the document that directly contains the virtual document described by the assembly to which this assembly object belongs.
A virtual document can contain both simple and virtual documents, nested to any
level. An assembly is a group of assembly objects that describe the components of a virtual document.
If the assembly describes a virtual document that is nested in the hierarchy of another virtual
document, set parentObjectId
to the object ID of the document in the hierarchy that
directly contains the virtual document described by the assembly.
If the assembly describes the
top-most virtual document in the hierarchy, set parentObjectId
to the object ID of the
top-most virtual document.
parentObjectId
- An IDfId object that contains the object ID of the directly containing documentDfException
- if the server returns an errorIDfId getComponentChronicleId() throws DfException
For more information about version trees and chronicle IDs, refer to Server Fundamentals.
DfException
- if the server returns an errorvoid setComponentChronicleId(IDfId chronId) throws DfException
The component_chron_id attribute records the chronicle ID of the component represented by the assembly object. The chronicle ID is the object ID of the first version in the component's version tree.
chronId
- An IDfId object that contains the chronicle ID of the componentDfException
- if the server returns an errorIDfId getComponentId() throws DfException
For more information about assemblies and virtual documents, refer to Server Fundamentals.
DfException
- if the server returns an errorvoid setComponentId(IDfId objectId) throws DfException
The component_id attribute records the object ID of the component represented by this assembly object.
objectId
- An IDfId object that contains component's object IDDfException
- if the server returns an errorint getDepth() throws DfException
A virtual document can
contain both simple and virtual documents, nested to any level. This method returns the nested depth of
the component represented by the assembly object in the top-most virtual document. The top-most virtual
document is the document identified in the book_id attribute. You can obtain the object ID of that
document using getBookId()
.
DfException
- if the server returns an errorvoid setDepth(int depth) throws DfException
The depth_no attribute records the level at
which the component is nested in the top-most virtual document's hierarchy. The top-most virtual
document is the document identified in the book_id attribute. You can obtain the object ID of that
document using getBookId()
.
depth
- Set this to an integer value corresponding to the depth of this component.DfException
- if the server returns an errordouble getOrderNumber() throws DfException
Order numbers indicate the component's position within the virtual document's structure. They are typically assigned by the server when the component is added to the virtual document.
For more information about virtual document structure, refer to Server Fundamentals.
DfException
- if the server returns an errorvoid setOrderNumber(double orderNumber) throws DfException
Order numbers indicate the component's position within the virtual document's structure. They are typically assigned by the server when the component is added to the virtual document.
The order_no attribute in the assembly object records the order number of the component within the top-most virtual document's hierarchy.
For more information about virtual document structure, refer to Server Fundamentals.
orderNumber
- Set this to an integer corresponding to the order number of this componentDfException
- if the server returns an errorjava.lang.String getContainType() throws DfException
DfException
void setContainType(java.lang.String containType) throws DfException
DfException
java.lang.String getContainDescription() throws DfException
DfException
void setContainDescription(java.lang.String containDesc) throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.