public interface IDfTypedObject
Modifier and Type | Method and Description |
---|---|
void |
appendBoolean(java.lang.String attributeName,
boolean value)
Appends a boolean value to a repeating attribute.
|
void |
appendDouble(java.lang.String attributeName,
double value)
Appends a double value to a repeating attribute.
|
void |
appendId(java.lang.String attributeName,
IDfId value)
Appends an ID value to a repeating attribute.
|
void |
appendInt(java.lang.String attributeName,
int value)
Appends an integer value to a repeating attribute.
|
void |
appendString(java.lang.String attributeName,
java.lang.String value)
Appends a string value to a repeating attribute.
|
void |
appendTime(java.lang.String attributeName,
IDfTime value)
Appends a date/time value to a repeating attribute.
|
void |
appendValue(java.lang.String attributeName,
IDfValue value)
Appends a value stored in an IDfValue object to a repeating attribute.
|
java.lang.String |
dump()
Lists an object's attributes and their values.
|
java.util.Enumeration |
enumAttrs()
Returns an enumeration of IDfAttr objects.
|
int |
findAttrIndex(java.lang.String attributeName)
Returns the position of an attribute in the list of attributes that belong to this object.
|
int |
findBoolean(java.lang.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.
|
int |
findDouble(java.lang.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.
|
int |
findId(java.lang.String attributeName,
IDfId value)
Searches through the values in a repeating attribute and returns the index of the first value that
matches the specified ID value.
|
int |
findInt(java.lang.String attributeName,
int value)
Searches through the values in a repeating attribute and returns the index of the first value that
matches the specified integer value.
|
int |
findString(java.lang.String attributeName,
java.lang.String value)
Searches through the values in a repeating attribute and returns the index of the first value that
matches the specified string value.
|
int |
findTime(java.lang.String attributeName,
IDfTime value)
Searches through the values in a repeating attribute and returns the index of the first value that
matches the specified date/time value.
|
int |
findValue(java.lang.String attributeName,
IDfValue value)
Searches through the values in a repeating attribute and returns the index of the first value that
matches the specified value.
|
java.lang.String |
getAllRepeatingStrings(java.lang.String attributeName,
java.lang.String separator)
Returns all the values stored in a repeating attribute as a single string.
|
IDfAttr |
getAttr(int attrIndex)
Returns an attribute description.
|
int |
getAttrCount()
Returns the number of attributes belonging to this object.
|
int |
getAttrDataType(java.lang.String attributeName)
Returns the data type of an attribute.
|
boolean |
getBoolean(java.lang.String attributeName)
Returns the boolean value of an attribute.
|
double |
getDouble(java.lang.String attributeName)
Returns the double value of an attribute.
|
IDfId |
getId(java.lang.String attributeName)
Returns the ID value of an attribute.
|
int |
getInt(java.lang.String attributeName)
Returns the integer value of an attribute.
|
long |
getLong(java.lang.String attributeName)
Returns the long integer value of an attribute.
|
IDfId |
getObjectId()
Returns the ID of this object.
|
IDfSession |
getObjectSession()
Gets the session to the Docbase containing the object.
|
IDfSession |
getOriginalSession()
Gets the session through which the object was originally requested.
|
boolean |
getRepeatingBoolean(java.lang.String attributeName,
int valueIndex)
Returns a boolean value stored in a repeating attribute.
|
double |
getRepeatingDouble(java.lang.String attributeName,
int valueIndex)
Returns a double value stored in a repeating attribute.
|
IDfId |
getRepeatingId(java.lang.String attributeName,
int valueIndex)
Returns an Object ID value stored in a repeating attribute.
|
int |
getRepeatingInt(java.lang.String attributeName,
int valueIndex)
Returns an integer value stored in a repeating attribute.
|
long |
getRepeatingLong(java.lang.String attributeName,
int valueIndex)
Returns a long integer value stored in a repeating attribute.
|
java.lang.String |
getRepeatingString(java.lang.String attributeName,
int valueIndex)
Returns a string value stored in a repeating attribute.
|
IDfTime |
getRepeatingTime(java.lang.String attributeName,
int valueIndex)
Returns a date/time value stored in a repeating attribute.
|
IDfValue |
getRepeatingValue(java.lang.String attributeName,
int valueIndex)
Returns a value stored in a repeating attribute as an IDfValue object.
|
IDfSession |
getSession()
Gets the session through which the object was originally requested.
|
IDfSessionManager |
getSessionManager()
Returns the session manager associated with this object.
|
java.lang.String |
getString(java.lang.String attributeName)
Returns the string value of an attribute.
|
IDfTime |
getTime(java.lang.String attributeName)
Returns the date/time value of an attribute.
|
IDfValue |
getValue(java.lang.String attributeName)
Returns the value of an attribute asn an IDfValue object.
|
IDfValue |
getValueAt(int index)
Returns the value stored in the attribute at the specified attribute index.
|
int |
getValueCount(java.lang.String attributeName)
Returns the number of values stored in an attribute.
|
boolean |
hasAttr(java.lang.String attributeName)
Indicates whether an attribute exists for this object.
|
void |
insertBoolean(java.lang.String attributeName,
int valueIndex,
boolean value)
Inserts a boolean value into a repeating attribute.
|
void |
insertDouble(java.lang.String attributeName,
int valueIndex,
double value)
Inserts a double value into a repeating attribute.
|
void |
insertId(java.lang.String attributeName,
int valueIndex,
IDfId value)
Inserts an Object ID value into a repeating attribute.
|
void |
insertInt(java.lang.String attributeName,
int valueIndex,
int value)
Inserts an integer value into a repeating attribute.
|
void |
insertString(java.lang.String attributeName,
int valueIndex,
java.lang.String value)
Inserts a string value into a repeating attribute.
|
void |
insertTime(java.lang.String attributeName,
int valueIndex,
IDfTime value)
Inserts a date/time value into a repeating attribute.
|
void |
insertValue(java.lang.String attributeName,
int valueIndex,
IDfValue value)
Inserts a variant value into a repeating attribute.
|
boolean |
isAttrRepeating(java.lang.String attributeName)
Indicates whether an attribute is a repeating attribute.
|
boolean |
isNull(java.lang.String attributeName)
Reserved for future use.
|
void |
remove(java.lang.String attributeName,
int valueIndex)
Removes a value stored in a repeating attribute.
|
void |
removeAll(java.lang.String attributeName)
Removes all values stored in a repeating attribute.
|
void |
setBoolean(java.lang.String attributeName,
boolean value)
Sets the boolean value of an attribute.
|
void |
setDouble(java.lang.String attributeName,
double value)
Sets the double value of an attribute.
|
void |
setId(java.lang.String attributeName,
IDfId value)
Sets the Object ID value of an attribute.
|
void |
setInt(java.lang.String attributeName,
int value)
Sets the integer value of an attribute.
|
void |
setNull(java.lang.String attributeName)
Reserved for future use.
|
void |
setRepeatingBoolean(java.lang.String attributeName,
int valueIndex,
boolean value)
Sets a boolean value of a repeating attribute.
|
void |
setRepeatingDouble(java.lang.String attributeName,
int valueIndex,
double value)
Sets a double value of a repeating attribute.
|
void |
setRepeatingId(java.lang.String attributeName,
int valueIndex,
IDfId value)
Sets a Object ID value of a repeating attribute.
|
void |
setRepeatingInt(java.lang.String attributeName,
int valueIndex,
int value)
Sets an integer value of a repeating attribute.
|
void |
setRepeatingString(java.lang.String attributeName,
int valueIndex,
java.lang.String value)
Sets a string value of a repeating attribute.
|
void |
setRepeatingTime(java.lang.String attributeName,
int valueIndex,
IDfTime value)
Sets a date/time value of a repeating attribute.
|
void |
setRepeatingValue(java.lang.String attributeName,
int valueIndex,
IDfValue value)
Sets a value of a repeating attribute.
|
void |
setSessionManager(IDfSessionManager sessMgr)
Associates a session manager with this object.
|
void |
setString(java.lang.String attributeName,
java.lang.String value)
Sets the string value of an attribute.
|
void |
setTime(java.lang.String attributeName,
IDfTime value)
Sets the date/time value of an attribute.
|
void |
setValue(java.lang.String attributeName,
IDfValue value)
Sets the value of an attribute.
|
void |
truncate(java.lang.String attributeName,
int valueIndex)
Truncates the values stored in a repeating attribute.
|
void appendBoolean(java.lang.String attributeName, boolean value) throws DfException
attributeName
- the name of the attributevalue
- the boolean value that you want to appendDfException
- if a server error occursappendDouble(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)
void appendDouble(java.lang.String attributeName, double value) throws DfException
attributeName
- the name of the attributevalue
- the double value that you want to appendDfException
- if a server error occursappendBoolean(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)
void appendId(java.lang.String attributeName, IDfId value) throws DfException
attributeName
- the name of the attributevalue
- the object ID that you want to appendDfException
- if a server error occursappendBoolean(java.lang.String, boolean)
,
appendDouble(java.lang.String, double)
,
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)
void appendInt(java.lang.String attributeName, int value) throws DfException
attributeName
- the name of the attributevalue
- the integer value that you want to appendDfException
- if a server error occursappendBoolean(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)
void appendString(java.lang.String attributeName, java.lang.String value) throws DfException
attributeName
- the name of the attribute to which you want to append a string valuevalue
- the string value that you want to appendDfException
- if a server error occursappendBoolean(java.lang.String, boolean)
,
appendDouble(java.lang.String, double)
,
appendId(java.lang.String, com.documentum.fc.common.IDfId)
,
appendInt(java.lang.String, int)
,
appendTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
appendValue(java.lang.String, com.documentum.fc.common.IDfValue)
void appendTime(java.lang.String attributeName, IDfTime value) throws DfException
attributeName
- the name of the repeating attributevalue
- the time value that you want to appendDfException
- if a server error occursappendBoolean(java.lang.String, boolean)
,
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)
,
appendValue(java.lang.String, com.documentum.fc.common.IDfValue)
void appendValue(java.lang.String attributeName, IDfValue value) throws DfException
attributeName
- the name of the repeating attributevalue
- the variant value that you want to appendDfException
- if a server error occursappendBoolean(java.lang.String, boolean)
,
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)
java.lang.String dump() throws DfException
dump
arranges the returned data
in three categories: User Attributes, System Attributes, and Application Attributes.DfException
- if a server error occursjava.util.Enumeration enumAttrs() throws DfException
Object o = my_object.enumAttrs()
Dim attr as IDfAttr
While o.hasMoreElements = true
Set attr = o.nextElement
name$ = attr.getName
Wend
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 en As IDfEnumeration
Dim attr as IDfAttr
Set en = clientx.getEnumeration(o)
While en.hasMoreElements = true
Set attr = en.nextElement
name$ = attr.getName
Wend
DfException
- if a server error occursint findAttrIndex(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributeDfException
- if a server error occursgetAttr(int)
int findBoolean(java.lang.String attributeName, boolean value) throws DfException
attributeName
- the name of the repeating attributevalue
- the boolean value to locateDfException
- if a server error occursfindDouble(java.lang.String, double)
,
findId(java.lang.String, com.documentum.fc.common.IDfId)
,
findInt(java.lang.String, int)
,
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)
int findDouble(java.lang.String attributeName, double value) throws DfException
attributeName
- the name of the repeating attributevalue
- the double value to locateDfException
- if a server error occursfindBoolean(java.lang.String, boolean)
,
findId(java.lang.String, com.documentum.fc.common.IDfId)
,
findInt(java.lang.String, int)
,
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)
int findId(java.lang.String attributeName, IDfId value) throws DfException
attributeName
- the name of the repeating attributevalue
- the object ID to locateDfException
- if a server error occursfindBoolean(java.lang.String, boolean)
,
findDouble(java.lang.String, double)
,
findInt(java.lang.String, int)
,
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)
int findInt(java.lang.String attributeName, int value) throws DfException
attributeName
- the name of the repeating attributevalue
- the integer value to locateDfException
- if a server error occursfindBoolean(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)
int findString(java.lang.String attributeName, java.lang.String value) throws DfException
attributeName
- the name of the repeating attributevalue
- the string value to locateDfException
- if a server error occursfindBoolean(java.lang.String, boolean)
,
findDouble(java.lang.String, double)
,
findId(java.lang.String, com.documentum.fc.common.IDfId)
,
findInt(java.lang.String, int)
,
findTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
findValue(java.lang.String, com.documentum.fc.common.IDfValue)
int findTime(java.lang.String attributeName, IDfTime value) throws DfException
attributeName
- the name of the repeating attributevalue
- the time value to locateDfException
- if a server error occursfindBoolean(java.lang.String, boolean)
,
findDouble(java.lang.String, double)
,
findId(java.lang.String, com.documentum.fc.common.IDfId)
,
findInt(java.lang.String, int)
,
findString(java.lang.String, java.lang.String)
,
findValue(java.lang.String, com.documentum.fc.common.IDfValue)
int findValue(java.lang.String attributeName, IDfValue value) throws DfException
attributeName
- the name of the repeating attributevalue
- the variant value to locateDfException
- if a server error occursfindBoolean(java.lang.String, boolean)
,
findDouble(java.lang.String, double)
,
findId(java.lang.String, com.documentum.fc.common.IDfId)
,
findInt(java.lang.String, int)
,
findString(java.lang.String, java.lang.String)
,
findTime(java.lang.String, com.documentum.fc.common.IDfTime)
java.lang.String getAllRepeatingStrings(java.lang.String attributeName, java.lang.String separator) throws DfException
separator
argument.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 specify
null
as the separator, a comma will be used to separate the returned
values.DfException
- if a server error occursIDfAttr getAttr(int attrIndex) throws DfException
attrIndex
- the index position of the attribute among the object's typesDfException
- if a server error occursfindAttrIndex(java.lang.String)
int getAttrCount() throws DfException
DfException
- if a server error occursint getAttrDataType(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributeDfException
- if a server error occursboolean getBoolean(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, false
is
returned.attributeName
- the name of the attributeDfException
- if a server error occursgetDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
double getDouble(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, 0.0
is
returned.attributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
IDfId getId(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, DfId.DF_nullID
is returned.attributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
int getInt(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, 0
is returned.attributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
long getLong(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, 0
is returned.attributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
IDfId getObjectId() throws DfException
DfException
- if an error occursboolean getRepeatingBoolean(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the desired boolean valueDfException
- if a server error occursgetRepeatingDouble(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
double getRepeatingDouble(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
IDfId getRepeatingId(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
int getRepeatingInt(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
long getRepeatingLong(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
java.lang.String getRepeatingString(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingDouble(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
IDfTime getRepeatingTime(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingDouble(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingValue(java.lang.String, int)
IDfValue getRepeatingValue(java.lang.String attributeName, int valueIndex) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -2 for valueIndex
will
return the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position of the value among the values stored in the repeating
attributeDfException
- if a server error occursgetRepeatingBoolean(java.lang.String, int)
,
getRepeatingDouble(java.lang.String, int)
,
getRepeatingId(java.lang.String, int)
,
getRepeatingInt(java.lang.String, int)
,
getRepeatingString(java.lang.String, int)
,
getRepeatingTime(java.lang.String, int)
IDfSession getObjectSession()
getOriginalSession()
IDfSession getOriginalSession()
getObjectSession()
IDfSession getSession()
getOriginalSession()
IDfSessionManager getSessionManager()
setSessionManager(com.documentum.fc.client.IDfSessionManager)
,
IDfSessionManager
java.lang.String getString(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, null is returnedattributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
IDfTime getTime(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values,
DfTime.DF_nullDATE
is returned.attributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getValue(java.lang.String)
IDfValue getValue(java.lang.String attributeName) throws DfException
attributeName
is a repeating attribute, the value at index 0 is returned.
If attributeName
is a repeating attribute without any values, false
is
returned.attributeName
- the name of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
IDfValue getValueAt(int index) throws DfException
index
- the index of the attributeDfException
- if a server error occursgetBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
int getValueCount(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributeDfException
- if a server error occursboolean hasAttr(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributetrue
if the specified attribute exists; false
if it does not.DfException
- if a server error occursvoid insertBoolean(java.lang.String attributeName, int valueIndex, boolean value) throws DfException
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 insertDfException
- if a server error occursinsertDouble(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)
void insertDouble(java.lang.String attributeName, int valueIndex, double value) throws DfException
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 insertDfException
- if a server error occursinsertBoolean(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)
void insertId(java.lang.String attributeName, int valueIndex, IDfId value) throws DfException
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 insertDfException
- if a server error occursinsertBoolean(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)
void insertInt(java.lang.String attributeName, int valueIndex, int value) throws DfException
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 insertDfException
- if a server error occursinsertBoolean(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)
void insertString(java.lang.String attributeName, int valueIndex, java.lang.String value) throws DfException
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 insertDfException
- if a server error occursinsertBoolean(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)
void insertTime(java.lang.String attributeName, int valueIndex, IDfTime value) throws DfException
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 insertDfException
- if a server error occursinsertBoolean(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)
void insertValue(java.lang.String attributeName, int valueIndex, IDfValue value) throws DfException
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 insertDfException
- if a server error occursinsertBoolean(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)
boolean isAttrRepeating(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributetrue
if the attribute is repeating; false
if it is not.DfException
- if a server error occursboolean isNull(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributeDfException
- if a server error occursvoid remove(java.lang.String attributeName, int valueIndex) throws DfException
attributeName
- the name of the repeating attributevalueIndex
- the index position where you want to remove a valueDfException
- if a server error occursvoid removeAll(java.lang.String attributeName) throws DfException
attributeName
- the name of the repeating attributeDfException
- if a server error occursvoid setBoolean(java.lang.String attributeName, boolean value) throws DfException
attributeName
- the name of the attributevalue
- the boolean valueDfException
- if a server error occurssetDouble(java.lang.String, double)
,
setId(java.lang.String, com.documentum.fc.common.IDfId)
,
setInt(java.lang.String, int)
,
setString(java.lang.String, java.lang.String)
,
setTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
setValue(java.lang.String, com.documentum.fc.common.IDfValue)
void setDouble(java.lang.String attributeName, double value) throws DfException
attributeName
- the name of the attributevalue
- the double valueDfException
- if a server error occurssetBoolean(java.lang.String, boolean)
,
setId(java.lang.String, com.documentum.fc.common.IDfId)
,
setInt(java.lang.String, int)
,
setString(java.lang.String, java.lang.String)
,
setTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
setValue(java.lang.String, com.documentum.fc.common.IDfValue)
void setId(java.lang.String attributeName, IDfId value) throws DfException
attributeName
- the name of the attributevalue
- an IDfId interface to the object IDDfException
- if a server error occurssetBoolean(java.lang.String, boolean)
,
setDouble(java.lang.String, double)
,
setInt(java.lang.String, int)
,
setString(java.lang.String, java.lang.String)
,
setTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
setValue(java.lang.String, com.documentum.fc.common.IDfValue)
void setInt(java.lang.String attributeName, int value) throws DfException
attributeName
- the name of the attributevalue
- the integer valueDfException
- if a server error occurssetBoolean(java.lang.String, boolean)
,
setDouble(java.lang.String, double)
,
setId(java.lang.String, com.documentum.fc.common.IDfId)
,
setString(java.lang.String, java.lang.String)
,
setTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
setValue(java.lang.String, com.documentum.fc.common.IDfValue)
void setNull(java.lang.String attributeName) throws DfException
attributeName
- the name of the attributeDfException
- if a server error occursvoid setRepeatingBoolean(java.lang.String attributeName, int valueIndex, boolean value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.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 assignDfException
- if a server error occurssetRepeatingDouble(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)
void setRepeatingDouble(java.lang.String attributeName, int valueIndex, double value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position where you want to assign a double valuevalue
- the double valueDfException
- if a server error occurssetRepeatingBoolean(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)
void setRepeatingId(java.lang.String attributeName, int valueIndex, IDfId value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position where you want to assign an object IDvalue
- the object IDDfException
- if a server error occurssetRepeatingBoolean(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)
void setRepeatingInt(java.lang.String attributeName, int valueIndex, int value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position where you want to assign an integer valuevalue
- the integer valueDfException
- if a server error occurssetRepeatingBoolean(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)
void setRepeatingString(java.lang.String attributeName, int valueIndex, java.lang.String value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position where you want to assign a string valuevalue
- the string valueDfException
- if a server error occurssetRepeatingBoolean(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)
void setRepeatingTime(java.lang.String attributeName, int valueIndex, IDfTime value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.attributeName
- The name of the repeating attributevalueIndex
- The index position where you want to assign a time valuevalue
- The time valueDfException
- if a server error occurssetRepeatingBoolean(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)
void setRepeatingValue(java.lang.String attributeName, int valueIndex, IDfValue value) throws DfException
valueIndex
is 0. Note
that negative values are interpreted as 0. For example, passing -1 for valueIndex
will set
the value at index 0.attributeName
- the name of the repeating attributevalueIndex
- the index position where you want to assign a variant valuevalue
- the variant valueDfException
- if a server error occurssetRepeatingBoolean(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)
void setSessionManager(IDfSessionManager sessMgr) throws DfException
sessMgr
- DfException
getSessionManager()
,
IDfSessionManager
,
IDfSessionManager.beginClientControl()
,
IDfSessionManager.beginTransaction()
void setString(java.lang.String attributeName, java.lang.String value) throws DfException
attributeName
- the name of the attributevalue
- the string valueDfException
- if a server error occurssetBoolean(java.lang.String, boolean)
,
setDouble(java.lang.String, double)
,
setId(java.lang.String, com.documentum.fc.common.IDfId)
,
setInt(java.lang.String, int)
,
setTime(java.lang.String, com.documentum.fc.common.IDfTime)
,
setValue(java.lang.String, com.documentum.fc.common.IDfValue)
void setTime(java.lang.String attributeName, IDfTime value) throws DfException
attributeName
- the name of the attributevalue
- the time valueDfException
- if a server error occurssetBoolean(java.lang.String, boolean)
,
setDouble(java.lang.String, double)
,
setId(java.lang.String, com.documentum.fc.common.IDfId)
,
setInt(java.lang.String, int)
,
setString(java.lang.String, java.lang.String)
,
setValue(java.lang.String, com.documentum.fc.common.IDfValue)
void setValue(java.lang.String attributeName, IDfValue value) throws DfException
attributeName
- the name of the attributevalue
- an IDfValue value containing the value that you want to assign to this attributeDfException
- if a server error occurssetBoolean(java.lang.String, boolean)
,
setDouble(java.lang.String, double)
,
setId(java.lang.String, com.documentum.fc.common.IDfId)
,
setInt(java.lang.String, int)
,
setString(java.lang.String, java.lang.String)
,
setTime(java.lang.String, com.documentum.fc.common.IDfTime)
void truncate(java.lang.String attributeName, int valueIndex) throws DfException
cities
attribute contains the following values:
[0] New York [1] Bombay [2] Paris [3] TokyoIf you call
my_object.truncate(cities, 2)
, the cities
attribute contains the following values:
[0] New York [1] Bombay
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 removedDfException
- if a server error occursCopyright 1994-2023 OpenText Corporation. All rights reserved.