Package com.documentum.fc.client
Interface IDfTypedObject
- All Known Subinterfaces:
IDfACL,IDfAcsConfig,IDfActivity,IDfAliasSet,IDfAspectRelation,IDfAssembly,IDfAuditTrail,IDfBocsConfig,IDfCollection,IDfContainment,IDfContentCollection,IDfContentTransferConfig,IDfDmsConfig,IDfDocbaseMap,IDfDocument,IDfDumpRecord,IDfFolder,IDfForeignKey,IDfFormat,IDfGroup,IDfLoadRecord,IDfLocation,IDfMethodObject,IDfMountPoint,IDfNote,IDfPackage,IDfPersistentObject,IDfPlugin,IDfPolicy,IDfProcess,IDfQueueItem,IDfRelation,IDfRelationType,IDfRetainer,IDfRouter,IDfSearchResults,IDfServerMap,IDfSessionManagerConfig,IDfSmartList,IDfStateExtension,IDfSysObject,IDfSysObjectStream,IDfType,IDfUser,IDfValidationDescriptor,IDfWorkflow,IDfWorkflowAttachment,IDfWorkitem,com.documentum.fc.client.internal.IPersistentObjectInternal,com.documentum.fc.client.internal.ITypedObjectInternal
public interface IDfTypedObject
Public operations for all typed objects.
-
Method Summary
Modifier and TypeMethodDescriptionvoidappendBoolean(String attributeName, boolean value) Appends a boolean value to a repeating attribute.voidappendDouble(String attributeName, double value) Appends a double value to a repeating attribute.voidAppends an ID value to a repeating attribute.voidAppends an integer value to a repeating attribute.voidappendString(String attributeName, String value) Appends a string value to a repeating attribute.voidappendTime(String attributeName, IDfTime value) Appends a date/time value to a repeating attribute.voidappendValue(String attributeName, IDfValue value) Appends a value stored in an IDfValue object to a repeating attribute.dump()Lists an object's attributes and their values.Returns an enumeration of IDfAttr objects.intfindAttrIndex(String attributeName) Returns the position of an attribute in the list of attributes that belong to this object.intfindBoolean(String attributeName, boolean value) Searches through the values in a repeating attribute and returns the index of the first value that matches the specified boolean value.intfindDouble(String attributeName, double value) Searches through the values in a repeating attribute and returns the index of the first value that matches the specified double value.intSearches through the values in a repeating attribute and returns the index of the first value that matches the specified ID value.intSearches through the values in a repeating attribute and returns the index of the first value that matches the specified integer value.intfindString(String attributeName, String value) Searches through the values in a repeating attribute and returns the index of the first value that matches the specified string value.intSearches through the values in a repeating attribute and returns the index of the first value that matches the specified date/time value.intSearches through the values in a repeating attribute and returns the index of the first value that matches the specified value.getAllRepeatingStrings(String attributeName, String separator) Returns all the values stored in a repeating attribute as a single string.getAttr(int attrIndex) Returns an attribute description.intReturns the number of attributes belonging to this object.intgetAttrDataType(String attributeName) Returns the data type of an attribute.booleangetBoolean(String attributeName) Returns the boolean value of an attribute.doubleReturns the double value of an attribute.Returns the ID value of an attribute.intReturns the integer value of an attribute.longReturns the long integer value of an attribute.Returns the ID of this object.Gets the session to the Docbase containing the object.Gets the session through which the object was originally requested.booleangetRepeatingBoolean(String attributeName, int valueIndex) Returns a boolean value stored in a repeating attribute.doublegetRepeatingDouble(String attributeName, int valueIndex) Returns a double value stored in a repeating attribute.getRepeatingId(String attributeName, int valueIndex) Returns an Object ID value stored in a repeating attribute.intgetRepeatingInt(String attributeName, int valueIndex) Returns an integer value stored in a repeating attribute.longgetRepeatingLong(String attributeName, int valueIndex) Returns a long integer value stored in a repeating attribute.getRepeatingString(String attributeName, int valueIndex) Returns a string value stored in a repeating attribute.getRepeatingTime(String attributeName, int valueIndex) Returns a date/time value stored in a repeating attribute.getRepeatingValue(String attributeName, int valueIndex) Returns a value stored in a repeating attribute as an IDfValue object.Gets the session through which the object was originally requested.Returns the session manager associated with this object.Returns the string value of an attribute.Returns the date/time value of an attribute.Returns the value of an attribute asn an IDfValue object.getValueAt(int index) Returns the value stored in the attribute at the specified attribute index.intgetValueCount(String attributeName) Returns the number of values stored in an attribute.booleanIndicates whether an attribute exists for this object.voidinsertBoolean(String attributeName, int valueIndex, boolean value) Inserts a boolean value into a repeating attribute.voidinsertDouble(String attributeName, int valueIndex, double value) Inserts a double value into a repeating attribute.voidInserts an Object ID value into a repeating attribute.voidInserts an integer value into a repeating attribute.voidinsertString(String attributeName, int valueIndex, String value) Inserts a string value into a repeating attribute.voidinsertTime(String attributeName, int valueIndex, IDfTime value) Inserts a date/time value into a repeating attribute.voidinsertValue(String attributeName, int valueIndex, IDfValue value) Inserts a variant value into a repeating attribute.booleanisAttrRepeating(String attributeName) Indicates whether an attribute is a repeating attribute.booleanReserved for future use.voidRemoves a value stored in a repeating attribute.voidRemoves all values stored in a repeating attribute.voidsetBoolean(String attributeName, boolean value) Sets the boolean value of an attribute.voidSets the double value of an attribute.voidSets the Object ID value of an attribute.voidSets the integer value of an attribute.voidReserved for future use.voidsetRepeatingBoolean(String attributeName, int valueIndex, boolean value) Sets a boolean value of a repeating attribute.voidsetRepeatingDouble(String attributeName, int valueIndex, double value) Sets a double value of a repeating attribute.voidsetRepeatingId(String attributeName, int valueIndex, IDfId value) Sets a Object ID value of a repeating attribute.voidsetRepeatingInt(String attributeName, int valueIndex, int value) Sets an integer value of a repeating attribute.voidsetRepeatingString(String attributeName, int valueIndex, String value) Sets a string value of a repeating attribute.voidsetRepeatingTime(String attributeName, int valueIndex, IDfTime value) Sets a date/time value of a repeating attribute.voidsetRepeatingValue(String attributeName, int valueIndex, IDfValue value) Sets a value of a repeating attribute.voidsetSessionManager(IDfSessionManager sessMgr) Associates a session manager with this object.voidSets the string value of an attribute.voidSets the date/time value of an attribute.voidSets the value of an attribute.voidTruncates the values stored in a repeating attribute.
-
Method Details
-
appendBoolean
Appends a boolean value to a repeating attribute.- Parameters:
attributeName- the name of the attributevalue- the boolean value that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
appendDouble(java.lang.String, double)appendId(java.lang.String, com.documentum.fc.common.IDfId)appendInt(java.lang.String, int)appendString(java.lang.String, java.lang.String)appendTime(java.lang.String, com.documentum.fc.common.IDfTime)appendValue(java.lang.String, com.documentum.fc.common.IDfValue)
-
appendDouble
Appends a double value to a repeating attribute.- Parameters:
attributeName- the name of the attributevalue- the double value that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
appendBoolean(java.lang.String, boolean)appendId(java.lang.String, com.documentum.fc.common.IDfId)appendInt(java.lang.String, int)appendString(java.lang.String, java.lang.String)appendTime(java.lang.String, com.documentum.fc.common.IDfTime)appendValue(java.lang.String, com.documentum.fc.common.IDfValue)
-
appendId
Appends an ID value to a repeating attribute.- Parameters:
attributeName- the name of the attributevalue- the object ID that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
appendInt
Appends an integer value to a repeating attribute.- Parameters:
attributeName- the name of the attributevalue- the integer value that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
appendBoolean(java.lang.String, boolean)appendDouble(java.lang.String, double)appendId(java.lang.String, com.documentum.fc.common.IDfId)appendString(java.lang.String, java.lang.String)appendTime(java.lang.String, com.documentum.fc.common.IDfTime)appendValue(java.lang.String, com.documentum.fc.common.IDfValue)
-
appendString
Appends a string value to a repeating attribute.- Parameters:
attributeName- the name of the attribute to which you want to append a string valuevalue- the string value that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
appendTime
Appends a date/time value to a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalue- the time value that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
appendValue
Appends a value stored in an IDfValue object to a repeating attribute. The IDfValue datatype acts as a variant that can store any of the Documentum types. The Value object created to store the variant value is immutable (its value cannot be changed).- Parameters:
attributeName- the name of the repeating attributevalue- the variant value that you want to append- Throws:
DfException- if a server error occurs- See Also:
-
dump
Lists an object's attributes and their values. This method is primarily intended for debugging purposes.dumparranges the returned data in three categories: User Attributes, System Attributes, and Application Attributes.- Returns:
- a string containing the object's attributes and their values
- Throws:
DfException- if a server error occurs
-
enumAttrs
Returns an enumeration of IDfAttr objects. The enumeration interface is Java-specific. If you are programming with COM, you need to do one of the following: A. Call the methods of the Enumerator interface through IDispatch.
The following sample code demonstrates option A in Visual Basic.
B. Convert the interface to a IDfEnumeration interface by passing the enumeration interface to the getEnumeration() method in IDfClientX.Object o = my_object.enumAttrs() Dim attr as IDfAttr While o.hasMoreElements = true Set attr = o.nextElement name$ = attr.getName Wend
The following sample code demonstrates option B in Visual Basic.Object o = my_object.enumAttrs() Dim en As IDfEnumeration Dim attr as IDfAttr Set en = clientx.getEnumeration(o) While en.hasMoreElements =trueSet attr = en.nextElement name$ = attr.getName Wend- Returns:
- an Enumeration interface to all the attributes of the object
- Throws:
DfException- if a server error occurs
-
findAttrIndex
Returns the position of an attribute in the list of attributes that belong to this object.- Parameters:
attributeName- the name of the attribute- Returns:
- the index of the attribute in the object's list of attributes
- Throws:
DfException- if a server error occurs- See Also:
-
findBoolean
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified boolean value.- Parameters:
attributeName- the name of the repeating attributevalue- the boolean value to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
findDouble
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified double value.- Parameters:
attributeName- the name of the repeating attributevalue- the double value to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
findId
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified ID value.- Parameters:
attributeName- the name of the repeating attributevalue- the object ID to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
findInt
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified integer value.- Parameters:
attributeName- the name of the repeating attributevalue- the integer value to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
findBoolean(java.lang.String, boolean)findDouble(java.lang.String, double)findId(java.lang.String, com.documentum.fc.common.IDfId)findString(java.lang.String, java.lang.String)findTime(java.lang.String, com.documentum.fc.common.IDfTime)findValue(java.lang.String, com.documentum.fc.common.IDfValue)
-
findString
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified string value.- Parameters:
attributeName- the name of the repeating attributevalue- the string value to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
findTime
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified date/time value.- Parameters:
attributeName- the name of the repeating attributevalue- the time value to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
findValue
Searches through the values in a repeating attribute and returns the index of the first value that matches the specified value.- Parameters:
attributeName- the name of the repeating attributevalue- the variant value to locate- Returns:
- index the index of the value or -1 if the value can't be found.
- Throws:
DfException- if a server error occurs- See Also:
-
getAllRepeatingStrings
Returns all the values stored in a repeating attribute as a single string. The values are delimited with the string passed as theseparatorargument.- Parameters:
attributeName- the name of the repeating attributeseparator- the symbol that you want used to separate the retrieved values of the repeating attribute. The symbol can only be a single character. If you specifynullas the separator, a comma will be used to separate the returned values.- Returns:
- all values stored in the repeating attribute as a single delimited string
- Throws:
DfException- if a server error occurs
-
getAttr
Returns an attribute description.- Parameters:
attrIndex- the index position of the attribute among the object's types- Returns:
- an IDfAttr interface to the attribute
- Throws:
DfException- if a server error occurs- See Also:
-
getAttrCount
Returns the number of attributes belonging to this object.- Returns:
- the number of attributes belonging to the calling object
- Throws:
DfException- if a server error occurs
-
getAttrDataType
Returns the data type of an attribute. Note: If this method is used on an instance of IDfCollection then it can return unexpected values. The datatype it returns for an attribute that is part of a query collection is the type that Content Server returns. This may differ from the datatype that the IDfSysObject interface specifies for that attribute. The type returned may vary with the server’s underlying relational database. Workaround: Structure your application in such a way that you do not need to invoke this method.- Parameters:
attributeName- the name of the attribute- Returns:
- the data type of the attribute
- Throws:
DfException- if a server error occurs
-
getBoolean
Returns the boolean value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,falseis returned.- Parameters:
attributeName- the name of the attribute- Returns:
- the boolean value
- Throws:
DfException- if a server error occurs- See Also:
-
getDouble
Returns the double value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,0.0is returned.- Parameters:
attributeName- the name of the attribute- Returns:
- the double value
- Throws:
DfException- if a server error occurs- See Also:
-
getId
Returns the ID value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,DfId.DF_nullIDis returned.- Parameters:
attributeName- the name of the attribute- Returns:
- an IDfId interface to the object ID
- Throws:
DfException- if a server error occurs- See Also:
-
getInt
Returns the integer value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,0is returned.- Parameters:
attributeName- the name of the attribute- Returns:
- the integer value
- Throws:
DfException- if a server error occurs- See Also:
-
getLong
Returns the long integer value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,0is returned.- Parameters:
attributeName- the name of the attribute- Returns:
- the long integer value
- Throws:
DfException- if a server error occurs- Since:
- 5.1
- See Also:
-
getObjectId
Returns the ID of this object.- Returns:
- an IDfId interface to the object ID
- Throws:
DfException- if an error occurs
-
getRepeatingBoolean
Returns a boolean value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the desired boolean value- Returns:
- the boolean value
- Throws:
DfException- if a server error occurs- See Also:
-
getRepeatingDouble
Returns a double value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- the double value
- Throws:
DfException- if a server error occurs- See Also:
-
getRepeatingId
Returns an Object ID value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- an IDfId interface to the object ID
- Throws:
DfException- if a server error occurs- See Also:
-
getRepeatingInt
Returns an integer value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- the integer value
- Throws:
DfException- if a server error occurs- See Also:
-
getRepeatingLong
Returns a long integer value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- the long integer value
- Throws:
DfException- if a server error occurs- Since:
- 5.1
- See Also:
-
getRepeatingString
Returns a string value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- the string value
- Throws:
DfException- if a server error occurs- See Also:
-
getRepeatingTime
Returns a date/time value stored in a repeating attribute. You can call this method on a single-valued attribute as long asvalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- an IDfTime interface to the time value
- Throws:
DfException- if a server error occurs- See Also:
-
getRepeatingValue
Returns a value stored in a repeating attribute as an IDfValue object. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -2 forvalueIndexwill return the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position of the value among the values stored in the repeating attribute- Returns:
- an IDfValue interface to the variant value
- Throws:
DfException- if a server error occurs- See Also:
-
getObjectSession
IDfSession getObjectSession()Gets the session to the Docbase containing the object. This is the session that is used for most object operations because it the session which has direct access to the object data.- Returns:
- a session to the Docbase containing the object
- See Also:
-
getOriginalSession
IDfSession getOriginalSession()Gets the session through which the object was originally requested. The original session is typically used for operations that require access to the original Docbase scope from which the object was requested (This can be different than the Docbase in which the object resides).- Returns:
- the session through which the object was originally requested
- See Also:
-
getSession
IDfSession getSession()Gets the session through which the object was originally requested. This is the same asgetOriginalSession()- Returns:
- the session on which the object was originally obtained
-
getSessionManager
IDfSessionManager getSessionManager()Returns the session manager associated with this object.- Returns:
- an IDfSessionManager interface to the session manager
- Since:
- 5.1
- See Also:
-
getString
Returns the string value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values, null is returned- Parameters:
attributeName- the name of the attribute- Returns:
- the string value
- Throws:
DfException- if a server error occurs- See Also:
-
getTime
Returns the date/time value of an attribute. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,DfTime.DF_nullDATEis returned.- Parameters:
attributeName- the name of the attribute- Returns:
- an IDfTime interface to the time value
- Throws:
DfException- if a server error occurs- See Also:
-
getValue
Returns the value of an attribute asn an IDfValue object. If the attributeattributeNameis a repeating attribute, the value at index 0 is returned. IfattributeNameis a repeating attribute without any values,falseis returned.- Parameters:
attributeName- the name of the attribute- Returns:
- an IDfValue interface to the variant value
- Throws:
DfException- if a server error occurs- See Also:
-
getValueAt
Returns the value stored in the attribute at the specified attribute index. If the attribute at this index is a repeating attribute, the value at the value-index 0 is returned.- Parameters:
index- the index of the attribute- Returns:
- an IDfValue interface to the variant value
- Throws:
DfException- if a server error occurs- See Also:
-
getValueCount
Returns the number of values stored in an attribute. This will always return 1 for single-valued attributes, and return a non-negative number for repeating attributes.- Parameters:
attributeName- the name of the attribute- Returns:
- the number of values stored in the attribute
- Throws:
DfException- if a server error occurs
-
hasAttr
Indicates whether an attribute exists for this object.- Parameters:
attributeName- the name of the attribute- Returns:
trueif the specified attribute exists;falseif it does not.- Throws:
DfException- if a server error occurs
-
insertBoolean
Inserts a boolean value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert the boolean valuevalue- the boolean value that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertDouble(java.lang.String, int, double)insertId(java.lang.String, int, com.documentum.fc.common.IDfId)insertInt(java.lang.String, int, int)insertString(java.lang.String, int, java.lang.String)insertTime(java.lang.String, int, com.documentum.fc.common.IDfTime)insertValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
insertDouble
Inserts a double value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert a double valuevalue- the double value that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertBoolean(java.lang.String, int, boolean)insertId(java.lang.String, int, com.documentum.fc.common.IDfId)insertInt(java.lang.String, int, int)insertString(java.lang.String, int, java.lang.String)insertTime(java.lang.String, int, com.documentum.fc.common.IDfTime)insertValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
insertId
Inserts an Object ID value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert the object IDvalue- the object ID that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertBoolean(java.lang.String, int, boolean)insertDouble(java.lang.String, int, double)insertInt(java.lang.String, int, int)insertString(java.lang.String, int, java.lang.String)insertTime(java.lang.String, int, com.documentum.fc.common.IDfTime)insertValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
insertInt
Inserts an integer value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert the integer valuevalue- the integer value that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertBoolean(java.lang.String, int, boolean)insertDouble(java.lang.String, int, double)insertId(java.lang.String, int, com.documentum.fc.common.IDfId)insertString(java.lang.String, int, java.lang.String)insertTime(java.lang.String, int, com.documentum.fc.common.IDfTime)insertValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
insertString
Inserts a string value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert the string valuevalue- the string value that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertBoolean(java.lang.String, int, boolean)insertDouble(java.lang.String, int, double)insertId(java.lang.String, int, com.documentum.fc.common.IDfId)insertInt(java.lang.String, int, int)insertTime(java.lang.String, int, com.documentum.fc.common.IDfTime)insertValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
insertTime
Inserts a date/time value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert the time valuevalue- the time value that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertBoolean(java.lang.String, int, boolean)insertDouble(java.lang.String, int, double)insertId(java.lang.String, int, com.documentum.fc.common.IDfId)insertInt(java.lang.String, int, int)insertString(java.lang.String, int, java.lang.String)insertValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
insertValue
Inserts a variant value into a repeating attribute.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to insert the variant valuevalue- the variant value that you want to insert- Throws:
DfException- if a server error occurs- See Also:
-
insertBoolean(java.lang.String, int, boolean)insertDouble(java.lang.String, int, double)insertId(java.lang.String, int, com.documentum.fc.common.IDfId)insertInt(java.lang.String, int, int)insertString(java.lang.String, int, java.lang.String)insertTime(java.lang.String, int, com.documentum.fc.common.IDfTime)
-
isAttrRepeating
Indicates whether an attribute is a repeating attribute.- Parameters:
attributeName- the name of the attribute- Returns:
trueif the attribute is repeating;falseif it is not.- Throws:
DfException- if a server error occurs
-
isNull
Reserved for future use.- Parameters:
attributeName- the name of the attribute- Throws:
DfException- if a server error occurs
-
remove
Removes a value stored in a repeating attribute. The remaining rows in the attribute are renumbered. Do not use this method to remove tasks from a router.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to remove a value- Throws:
DfException- if a server error occurs
-
removeAll
Removes all values stored in a repeating attribute.- Parameters:
attributeName- the name of the repeating attribute- Throws:
DfException- if a server error occurs
-
setBoolean
Sets the boolean value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- the boolean value- Throws:
DfException- if a server error occurs- See Also:
-
setDouble
Sets the double value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- the double value- Throws:
DfException- if a server error occurs- See Also:
-
setId
Sets the Object ID value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- an IDfId interface to the object ID- Throws:
DfException- if a server error occurs- See Also:
-
setInt
Sets the integer value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- the integer value- Throws:
DfException- if a server error occurs- See Also:
-
setNull
Reserved for future use.- Parameters:
attributeName- the name of the attribute- Throws:
DfException- if a server error occurs
-
setRepeatingBoolean
Sets a boolean value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to assign the boolean valuevalue- the boolean value that you want to assign- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingDouble(java.lang.String, int, double)setRepeatingId(java.lang.String, int, com.documentum.fc.common.IDfId)setRepeatingInt(java.lang.String, int, int)setRepeatingString(java.lang.String, int, java.lang.String)setRepeatingTime(java.lang.String, int, com.documentum.fc.common.IDfTime)setRepeatingValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
setRepeatingDouble
Sets a double value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to assign a double valuevalue- the double value- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingBoolean(java.lang.String, int, boolean)setRepeatingId(java.lang.String, int, com.documentum.fc.common.IDfId)setRepeatingInt(java.lang.String, int, int)setRepeatingString(java.lang.String, int, java.lang.String)setRepeatingTime(java.lang.String, int, com.documentum.fc.common.IDfTime)setRepeatingValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
setRepeatingId
Sets a Object ID value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to assign an object IDvalue- the object ID- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingBoolean(java.lang.String, int, boolean)setRepeatingDouble(java.lang.String, int, double)setRepeatingInt(java.lang.String, int, int)setRepeatingString(java.lang.String, int, java.lang.String)setRepeatingTime(java.lang.String, int, com.documentum.fc.common.IDfTime)setRepeatingValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
setRepeatingInt
Sets an integer value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to assign an integer valuevalue- the integer value- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingBoolean(java.lang.String, int, boolean)setRepeatingDouble(java.lang.String, int, double)setRepeatingId(java.lang.String, int, com.documentum.fc.common.IDfId)setRepeatingString(java.lang.String, int, java.lang.String)setRepeatingTime(java.lang.String, int, com.documentum.fc.common.IDfTime)setRepeatingValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
setRepeatingString
Sets a string value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to assign a string valuevalue- the string value- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingBoolean(java.lang.String, int, boolean)setRepeatingDouble(java.lang.String, int, double)setRepeatingId(java.lang.String, int, com.documentum.fc.common.IDfId)setRepeatingInt(java.lang.String, int, int)setRepeatingTime(java.lang.String, int, com.documentum.fc.common.IDfTime)setRepeatingValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
setRepeatingTime
Sets a date/time value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- The name of the repeating attributevalueIndex- The index position where you want to assign a time valuevalue- The time value- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingBoolean(java.lang.String, int, boolean)setRepeatingDouble(java.lang.String, int, double)setRepeatingId(java.lang.String, int, com.documentum.fc.common.IDfId)setRepeatingInt(java.lang.String, int, int)setRepeatingString(java.lang.String, int, java.lang.String)setRepeatingValue(java.lang.String, int, com.documentum.fc.common.IDfValue)
-
setRepeatingValue
Sets a value of a repeating attribute. You can call this method on a single-valued attribute as long as thevalueIndexis 0. Note that negative values are interpreted as 0. For example, passing -1 forvalueIndexwill set the value at index 0.- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where you want to assign a variant valuevalue- the variant value- Throws:
DfException- if a server error occurs- See Also:
-
setRepeatingBoolean(java.lang.String, int, boolean)setRepeatingDouble(java.lang.String, int, double)setRepeatingId(java.lang.String, int, com.documentum.fc.common.IDfId)setRepeatingInt(java.lang.String, int, int)setRepeatingString(java.lang.String, int, java.lang.String)setRepeatingTime(java.lang.String, int, com.documentum.fc.common.IDfTime)
-
setSessionManager
Associates a session manager with this object.- Parameters:
sessMgr-- Throws:
DfException- Since:
- 5.1
- See Also:
-
setString
Sets the string value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- the string value- Throws:
DfException- if a server error occurs- See Also:
-
setTime
Sets the date/time value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- the time value- Throws:
DfException- if a server error occurs- See Also:
-
setValue
Sets the value of an attribute. If the attribute is a repeating attribute, this will set the value at index 0.- Parameters:
attributeName- the name of the attributevalue- an IDfValue value containing the value that you want to assign to this attribute- Throws:
DfException- if a server error occurs- See Also:
-
truncate
Truncates the values stored in a repeating attribute. The following example demonstrates how the truncate method works: Thecitiesattribute contains the following values:[0] New York [1] Bombay [2] Paris [3] Tokyo
If you callmy_object.truncate(cities, 2), thecitiesattribute contains the following values:[0] New York [1] Bombay
- Parameters:
attributeName- the name of the repeating attributevalueIndex- the index position where the truncation of values begins. All values stored at this index and above will be removed- Throws:
DfException- if a server error occurs
-