Hi,
I am using documentum 6.7. I would like to import a document from my local harddrive to a docbase location in content server. The following is my code.
My error:
Traceback (most recent call last):
File "dctmbase.py", line 30, in <module>
| import com.documentum.fc.client.DfQuery as DfQuery |
ImportError: No module named com.documentum.fc.client.DfQuery
"""
This class provides access to Documentum DFC API interfaces.
Class definitions are for syntax completion and are fully
documented from the DFC java docs version 6.5
"""
"""
To run a jython program from a java command line, follow this
syntax example:
Windows
java -Xmx512m -Xss1152k -Dpython.home="D:\Apps\jython2.5.1"
-Dpython.executable="path\to\batch\file"
-classpath "D:\Apps\jython2.5.1\jython.jar;
\Documentum\dfc\dctm.jar;
\Documentum\user\config;
C:\Program Files\Common Files\EMC\ExJNIAPIGateway.jar"
org.python.util.jython <jython.file.py>
UNIX
java -Xmx512m -Xss1024k
-classpath /usr/local/bin/../lib/jython/jython.jar:
/usr/local/dctm/shared/config:
/usr/local/dctm/shared/dctm.jar:
/usr/local/dctm/shared/dfc/dfc.jar
-Dpython.home=/usr/local/bin/../lib/jython
-Dpython.executable=/usr/local/bin/../lib/jython/bin/jython
org.python.util.jython bobs-report-gen-job.py
"""
# Documentum functional libraries
import com.documentum.fc.client.DfQuery as DfQuery
import com.documentum.fc.client.DfCollectionX as DfCollection
import com.documentum.fc.client.DfClient as DfClient
import com.documentum.fc.common as common
import com.documentum.fc.common.DfId as DfId
import com.documentum.fc.common.DfTime as DfTime
# Documentum exception libraries
import com.documentum.fc.common.DfException as DfException
import com.documentum.fc.client.DfServiceException as DfServiceException
import com.documentum.fc.client.DfDocbaseUnreachableException as DfDocbaseUnreachableException
import com.documentum.fc.client.DfIdNotFoundException as DfIdNotFoundException
import com.documentum.fc.client.DfAttributeValueException as DfAttributeValueException
import com.documentum.fc.client.DfNameNotFoundException as DfNameNotFoundException
import com.documentum.fc.client.DfPathNotFoundException as DfPathNotFoundException
import com.documentum.fc.client.content.DfContentObjectAccessException as DfContentObjectAccessException
##
# Documentum Constants
##
# Date format for datetime
dctmDateFormat = '%m/%d/%Y %I:%M:%S %p'
# Load the logging module
#import semodules.logger.logger as log
_dsession = None
def displaySessionInfo(sess):
"""
Prints relevant information about the current
repository session
"""
tabs = '\t' * 6
info = '\n' + \
tabs + '***Displaying Session Information***\n' + \
tabs + 'Docbase Name : %s\n' % sess.getDocbaseName() + \
tabs + 'Server Version : %s\n' % sess.getServerVersion() + \
tabs + 'DBMS Name : %s\n' % sess.getDBMSName() + \
tabs + 'Docbase Owner Name: %s\n' % sess.getDocbaseOwnerName() + \
tabs + 'Session Id : %s\n' % sess.getSessionId() + \
tabs + 'DMCL Session Id : %s\n' % sess.getDMCLSessionId() + \
tabs + 'Docbase Id : %s\n' % sess.getDocbaseId() + \
tabs + 'Docbase Scope : %s\n' % sess.getDocbaseScope() + \
tabs + 'Current User : %s\n' % sess.getLoginUserName() + \
tabs + 'Security Mode : %s\n' % sess.getSecurityMode() + \
tabs + '***End Session Information***\n' + \
tabs + ''
return info
def getDfIdFromID(oid):
"""Returns an instance of fc.common.IDfId"""
id = DfId(oid)
return id
def getDfTimeFromString(str):
"""Returns an instance of fc.common.IDfTime"""
t = DfTime(str)
return t
def getFormatExtension(sess, pObj = None, format = None):
""" Returns the Documentum format dos_extenstion for
the persistent object or format """
extension = None
try:
if not pObj == None and format == None:
try:
fmt = pObj.getFormat()
extension = fmt.getDOSExtension()
except DfException, e:
#log.logger(log.ERROR, 'Error retrieving format from persistent object')
#log.logger(log.ERROR, str(e))
raise
elif not format == None and pObj == None:
try:
fmt = sess.getFormat(format)
extension = fmt.getDOSExtension()
except DfException, e:
#log.logger(log.ERROR, 'Error retrieving format from sysobject object')
#log.logger(log.ERROR, str(e))
raise
else:
raise Exception('Error with parameters, Persistent Object and Format cannot both be None')
except Exception, e:
#log.logger(log.ERROR, str(e))
raise
return extension
def getObjectByQualification(dql):
global _dsession
try:
pObj = _dsession.getObjectByQualification(dql)
return pObj
except DfException, e:
raise
def connect(docbase, uname, upassword, udomain = None, uticket = None):
global _dsession
try:
client = DfClient.getLocalClient()
except DfException:
#log.logger(log.FATAL, 'Unexpected exception acquiring local client: %s' % str(e))
raise
li = common.DfLoginInfo()
li.setUser(uname)
li.setPassword(upassword)
if udomain != None:
li.setDomain(udomain)
try:
#log.logger(log.INFO, "Attempting to connect to Docbase: %s" % docbase)
_dsession = client.newSession(docbase, li)
#if _dsession.isConnected() == 1:
#print 'Connection to Documentum Successful'
#else:
#print 'Connection to Documentum Failed without exception!'
except DfException:
#log.loger(log.FATAL, 'Unexpected exception while connecting: %s' %str(e))
#print 'Connection Failed'
#print 'Repository: %s' % docbase
#print 'Username: %s' % li.getUser()
#print 'Password: %s' % li.getPassword()
raise
return _dsession
def disconnect():
global _dsession
if not _dsession:
return
if _dsession.isConnected() == 1:
try:
_dsession.disconnect()
return
except DfException:
raise
if _dsession.isConnected() == 1:
raise Exception('Disconnect failed with no exception.')
return
def setSession(sess):
global _dsession
_dsession = sess
return
def disconnectNamedSession(sess):
if sess.isConnected() == 1:
try:
sess.disconnect()
return
except DfException:
raise
if sess.isConnected() == 1:
raise Exception('Disconnect failed with no exception.')
return
def getACL(aclDomain, aclName):
"""
Returns an ACL object.
Refer to the Server Reference Manual for more information about
the ACL object type.
Parameters:
aclDomain - the ACL domain. The domain is the owner of the ACL.
aclName - the name of the ACL
Returns:
an IDfACL interface to the ACL object; null if the server
cannot find the specified ACL object.
Throws:
DfException - if a server error occurs.
"""
global _dsession
return _dsession.getACL(aclDomain, aclName)
def getFolderBySpecification(fldSpec):
"""
Returns the folder matching the folder specification or null if the
folder can not be found.
The folder specification can either be a folder path or a folder object id.
Parameters:
folderSpec - a path or object id for a folder
Returns:
a folder
Throws:
DfException - if the folder can not be found or some other error occurs
"""
global _dsession
try:
return _dsession.getFolderBySpecification(fldSpec)
except DfException:
return None
def getObject(IDfObjectID):
"""
Returns the ID of this object.
Returns:
an IDfId interface to the object ID
Throws:
DfException - if an error occurs
"""
global _dsession
return _dsession.getObject(IDfObjectID)
def getObjectByID(objID):
IDfObjectID = DfId(objID)
return getObject(IDfObjectID)
def getObjectByPath(pathSpec):
"""
Returns a Documentum server object given a full path to the object.
If multiple objects exist at the specified path, the server returns
one of the objects at random.
Parameters:
objectPath - the path to the object specified in the following
format: /cabinet_name/folder_name/object_name.
Returns:
an sysObject or DFC-derived interface to the object,
None if the server cannot find an object at the
specified path.
Throws:
DfException - if server error occurs.
"""
global _dsession
return _dsession.getObjectByPath(pathSpec)
def getSession():
global _dsession
return _dsession
def newObject(typeName):
"""
Creates a persistent object given a specified Documentum server type.
Even though the new object has an object id, the object is not committed
to a repository until you call the save method.
Parameters:
typeName - the object type of the new object, with underscores.
For example, enter dm_document to create a document object.
Returns:
an IDfPersistentObject interface to the new object.
Throws:
DfException - if a server error occurs.
"""
global _dsession
return _dsession.newObject(typeName)
def queryDocbase(dqlStr, queryType = None):
"""
Executes a DQL query.
Parameters:
dqlStr - The DQL statement. Queries are written with the
Document Query Language (DQL). Refer to the Server
DQL Reference Manual for more information about DQL
statements.
queryType - the type of query that you want to execute;
The following list specifies the integer
corresponding to all query types:
Integer Query Type
0 READ QUERY
1 QUERY
2 CACHE QUERY
3 EXECUTE QUERY
4 EXECUTE READ QUERY
5 APPLY
Returns:
an IDfCollection interface to the query results.
Throws:
DfException - if the query fails to execute or if the
specified session has timed out and cannot
be re-established.
"""
global _dsession
#qTypes = [0, 1, 2, 3, 4, 5]
q = DfQuery()
q.setDQL(dqlStr)
try:
return q.execute(_dsession, DfQuery.DF_QUERY)
except Exception:
raise
def getUserList(state = 0):
"""
Retreives a list of users from the connected repository
state = 0 >> Both Active and InActive
state = 1 >> Active Only
state = 2 >> Inactive Only
"""
global _dsession
sql = "SELECT r_object_id, user_name FROM dm_user " \
+ "WHERE r_is_group = False "
if state == 1:
sql += 'AND user_state = 0'
elif state == 2:
sql += 'AND user_state > 0'
return queryDocbase(sql)
###
#
# Dummy java classes
#
###
class ByteArrayInputStream(object):
"""
From java.io.InputStream
"""
def doNothing():
return
class Date():
"""
From java.util.Date
"""
def doNothing():
return
###
#
# Interfaces from com.documentum.fc.common
#
###
class IDfAttr():
"""
From com.documentum.fc.common
This interface provides access to the following information about attributes: name, length, type and whether an attribute is repeating.
int getAllowedLength(String value)
Retrieves the number of characters that will fit in the attribute for a given string.
int getDataType()
Retrieves the datatype of an attribute.
String getId()
int getLength()
Retrieves the maximum number of bytes in a string attribute.
String getName()
Retrieves the name of an attribute.
boolean isQualifiable()
boolean isRepeating()
Indicates whether an attribute is repeating.
"""
def getLength():
"""
getLength()
Retrieves the maximum number of bytes in a string attribute.
Returns:
the maximum number of bytes in a string attribute. 0 is returned for all non-string attributes.
"""
return int()
def getName():
"""
getName()
Retrieves the name of an attribute.
Returns:
the name of the attribute
"""
return str()
def getDataType():
"""
getDataType()
Retrieves the datatype of an attribute.
The following list specifies the dataype corresponding to all return values.
Value Datatype
0 Boolean
1 Integer
2 String
3 ID
4 Time, or date
5 Double
6 Undefined
Note: This method 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.
Returns:
an integer representing the datatype of the attribute. The possible return values are DM_BOOLEAN, DM_INTEGER, DM_STRING, DM_ID, DM_TIME, DM_DOUBLE, and DM_UNDFINED.
"""
return int()
def isRepeating():
"""
isRepeating()
Indicates whether an attribute is repeating.
Returns:
TRUE if the attribute is repeating; FALSE if it is not.
"""
return bool()
def getAllowedLength(value):
"""
getAllowedLength(String value)
Retrieves the number of characters that will fit in the attribute for a given string.
Parameters:
value - specifies the string for evaluation. The value could not be a null.
Returns:
value indicates the position in the string that truncation would occur.
"""
return int()
def getId():
"""
getId()
"""
return str()
def isQualifiable():
"""
isQualifiable()
"""
return bool()
class IDfChangeDescription():
"""
From com.documentum.fc.common
public interface IDfChangeDescription
This class is used to maintain information about change description records. Change description records are typically used to track changes in the Virtual Document Manager.
Method Summary
int getChangeSequenceNumber()
Returns the sequence number of this change description record.
int getCode()
Returns the unique change description code for the change description text.
String getContextTag()
Returns the context tag of this change description record.
String getDescription()
Returns the textual description of the change.
IDfId getObjectId()
Returns the object ID of the object affected by the change described in this change description record.
"""
def getContextTag():
"""
getContextTag()
Returns the context tag of this change description record.
Context tags are a mechanism for categorizing change descriptions. If the change is applicable to a VDM window, the context tag uniquely identifies that window. It is set when the change description record is created. (Change descriptions are created through the IDfVirtualDocument interface.)
Returns:
The context tag of this change description record
"""
return str()
def getObjectId():
"""
getObjectId()
Returns the object ID of the object affected by the change described in this change description record.
Returns:
An IDfId object that contains the object ID
"""
return IDfId()
def getDescription():
"""
getDescription()
Returns the textual description of the change.
The description is defined when the change description record is created. Change desription records are created through the IDfVirtualDocument interface.
Returns:
The description of the change
"""
return str()
def getChangeSequenceNumber():
"""
getChangeSequenceNumber()
Returns the sequence number of this change description record.
The system maintains change description records for each open Virtual Document Manager window. In the set of change descriptions for an open window, each change description has a unique sequence number. The numbers are integers. Sequence numbers increment by 1 with each change.
Returns:
The sequence number of this change description record
"""
return int()
def getCode():
"""
getCode()
Returns the unique change description code for the change description text.
Each textual change description has a unique code number. Using this code number allows you to identify a change description without manipulating the complete description.
Returns:
The change description code corresponding to the change description string
"""
return int()
class IDfId():
"""
From com.documentum.fc.common
int compareTo(IDfId dfid)
Returns -1, 0 or 1 if this IDfId is less than, equal to, or greater than the IDfId passed as an argument.
boolean equals(Object that)
Indicates whether some other object is "equal to" this one.
String getDocbaseId()
Returns the portion of the ID that identifies the repository.
String getId()
Returns a string representation of the ID.
long getNumericDocbaseId()
Returns the portion of the ID that represents the docbase ID in integer form.
int getTypePart()
Returns the portion of the ID that represents the object type.
boolean isNull()
Indicates whether this IDfId object represents a null ID. ("0000000000000000").
boolean isObjectId()
Indicates whether this ID is a valid object ID.
String toString()
Returns a string representation of this ID.
"""
def getDocbaseId():
"""
getDocbaseId()
Returns the portion of the ID that identifies the repository.
Returns:
the portion of the ID that identifies the repository. If this ID was created from a string that does not represent a repository object, the results are undefined.
"""
return str()
def getNumericDocbaseId():
"""
getNumericDocbaseId()
Returns the portion of the ID that represents the docbase ID in integer form.
Returns:
an integer expressing the docbase ID
"""
return long()
def getId():
"""
getId()
Returns a string representation of the ID.
Returns:
the ID as a string.
"""
return str()
def getTypePart():
"""
getTypePart()
Returns the portion of the ID that represents the object type.
The type part is converted to an integer. For example, if the underlying ID is "099af3ce800001ff", this method returns 9. If the ID is "469af3ce80000200", this method returns 70 decimal (46 hex).
Returns:
an integer expressing the object type
"""
return int()
def isNull():
"""
isNull()
Indicates whether this IDfId object represents a null ID. ("0000000000000000").
Returns:
true if this object represents the NULLID, or false if it is not.
"""
return bool()
def equals(that):
"""
equals(Object that)
Indicates whether some other object is "equal to" this one.
If the argument is not an instance of IDfId, this method returns false. If this object represents a NULLID ("0000000000000000") and the argument id equals null (or if it is a NULLID itself), this method will return true.
Overrides:
equals in class Object
Parameters:
that - another object
Returns:
true if the argument ID is equal to this one, or false if it is not equal.
"""
return bool()
def toString():
"""
toString()
Returns a string representation of this ID.
Overrides:
toString in class Object
Returns:
a string representation of this ID.
"""
return str()
def compareTo(dfid):
"""
compareTo(IDfId dfid)
Returns -1, 0 or 1 if this IDfId is less than, equal to, or greater than the IDfId passed as an argument. If the ID argument does not represent a Documentum ID, the results of this method are undefined.
Parameters:
dfid - another IDfId instance.
Returns:
-1 if this ID is less than the argument, 0 if the two IDs are equal, or 1 if this ID is greater than the argument ID.
"""
return int()
def isObjectId():
""""
isObjectId()
Indicates whether this ID is a valid object ID.
"""
return bool()
class IDfList():
"""
This interface provides functionality that encapsulates Vector operations.
int append(Object value)
Appends an Object instance to the list.
int appendBoolean(boolean value)
Appends a boolean value to the list.
int appendDouble(double value)
Appends a double value to the list.
int appendId(IDfId value)
Appends an instance of an IDfId object to the list.
int appendInt(int value)
Appends an int value to the list.
int appendList(IDfList value)
Appends an instance of an IDfList object to the list.
int appendString(String value)
Appends a string value to the list.
int appendTime(IDfTime value)
Appends an instance of an IDfTime object to the list.
int appendValue(IDfValue value)
Appends an instance of an IDfValue object to the list.
int findBooleanIndex(boolean value)
Returns the index of the first occurrence of a boolean value in the list.
int findDoubleIndex(double value)
Returns the index of the first occurrence of a double value in the list.
int findIdIndex(IDfId value)
Returns the index of the first occurrence of an IDfId object in the list.
int findIndex(Object value)
Returns the index of the first occurrence of the Object in the list.
int findIntIndex(int value)
Returns the index of the first occurrence of an int value in the list.
int findListIndex(IDfList value)
Returns the index of the first occurrence of an IDfList object in the list.
int findStringIndex(String value)
Returns the index of the first occurrence of a string value in the list.
int findTimeIndex(IDfTime value)
Returns the index of the first occurrence of an IDfTime object in the list.
int findValueIndex(IDfValue value)
Returns the index of the first occurrence of an IDfValue object in the list.
Object get(int index)
Fetches an Object instance from the list at the specified index.
boolean getBoolean(int index)
Fetches a boolean value from the list at the specified index.
int getCount()
Returns the number of items in the list.
double getDouble(int index)
Fetches a double value from the list at the specified index.
int getElementType()
Returns the datatype of the items added to the list.
int getElementTypeAt(int index)
Returns the datatype of the items added to the list at the specified index.
IDfId getId(int index)
Fetches an instance of an IDfId object from the list at the specified index.
int getInt(int index)
Fetches an int value from the list at the specified index.
IDfList getList(int index)
Fetches an instance of an IDfList object from the list at the specified index.
String getString(int index)
Fetches a string value from the list at the specified index.
IDfTime getTime(int index)
Fetches an instance of an IDfTime object from the list at the specified index.
IDfValue getValue(int index)
Fetches an instance of an IDfValue object from the list at the specified index.
void insert(int index, Object value)
Inserts an Object instance into the list at a specified index.
void insertAll(int index, IDfList list)
Inserts all objects contained in an IDfList object into the list at a specified index.
void insertBoolean(int index, boolean value)
Inserts a boolean value into the list at a specified index.
void insertDouble(int index, double value)
Inserts a double value into the list at a specified index.
void insertId(int index, IDfId value)
Inserts an instance of an IDfId object into the list at a specified index.
void insertInt(int index, int value)
Inserts an int value into the list at a specified index.
void insertList(int index, IDfList value)
Inserts an instance of an IDfList object into the list at a specified index.
void insertString(int index, String value)
Inserts a string value into the list at a specified index.
void insertTime(int index, IDfTime value)
Inserts an instance of an IDfTime object into the list at a specified index.
void insertValue(int index, IDfValue value)
Inserts an instance of an IDfValue object into the list at a specified index.
void remove(int index)
Removes an item from the list at the specified index.
void removeAll()
Removes all items from the list and set its size to zero.
void set(int index, Object value)
Adds an Object instance into the list at a specified index.
void setBoolean(int index, boolean value)
Adds a boolean value into the list at a specified index.
void setDouble(int index, double value)
Adds a double value into the list at a specified index.
void setElementType(int type)
Sets the element type for the list.
void setId(int index, IDfId value)
Adds an instance of an IDfId interface into the list at a specified index.
void setInt(int index, int value)
Adds an int value into the list at a specified index.
void setList(int index, IDfList value)
Adds an instance of an IDfList interface into the list at a specified index.
void setString(int index, String value)
Adds a string value into the list at a specified index.
void setTime(int index, IDfTime value)
Adds an instance of an IDfTime interface into the list at a specified index.
void setValue(int index, IDfValue value)
Adds an instance of an IDfValue interface into the list at a specified index.
"""
def append(value):
"""
append(Object value)
Appends an Object instance to the list.
Parameters:
value - the object instance to add to the list.
Returns:
the size of the list after the append.
Throws:
DfException - if there is a type mismatch
"""
return
def appendString(value):
"""
appendString(String value)
Appends a string value to the list.
Parameters:
value - the string value to add to the list.
Returns:
the size of the list after the appendString.
Throws:
DfException - if there is a type mismatch
"""
return
def appendInt(value):
"""
appendInt(int value)
Appends an int value to the list.
Parameters:
value - the int value to add to the list.
Returns:
the size of the list after the appendInt.
Throws:
DfException - if there is a type mismatch
"""
return
def appendDouble(value):
"""
appendDouble(double value)
Appends a double value to the list.
Parameters:
value - the double value to add to the list.
Returns:
the size of the list after the appendDouble.
Throws:
DfException - if there is a type mismatch
"""
return
def appendBoolean(value):
"""
appendBoolean(boolean value)
Appends a boolean value to the list.
Parameters:
value - the boolean value to add to the list.
Returns:
the size of the list after the appendBoolean.
Throws:
DfException - if there is a type mismatch
"""
return
def appendId(value):
"""
appendId(IDfId value)
Appends an instance of an IDfId object to the list.
Parameters:
value - the IDfId object to add to the list.
Returns:
the size of the list after the appendId.
Throws:
DfException - if there is a type mismatch
"""
return
def appendTime(value):
"""
appendTime(IDfTime value)
Appends an instance of an IDfTime object to the list.
Parameters:
value - the IDfTime object to add to the list.
Returns:
the size of the list after the appendTime.
Throws:
DfException - if there is a type mismatch
"""
return
def appendValue(value):
"""
appendValue(IDfValue value)
Appends an instance of an IDfValue object to the list.
Parameters:
value - the IDfValue object to add to the list.
Returns:
the size of the list after the appendValue.
Throws:
DfException - if there is a type mismatch
"""
return
def appendList(value):
"""
appendList(IDfList value)
Appends an instance of an IDfList object to the list.
Parameters:
value - the IDfList object to add to the list.
Returns:
the size of the list after the appendList.
Throws:
DfException - if there is a type mismatch
"""
return
def insert(index, value):
"""
insert(int index, Object value)
Inserts an Object instance into the list at a specified index.
Parameters:
index - the location where the object will be inserted into the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch, a null pointer exception, or an index out of bounds
"""
return
def insertString(index, value):
"""
insertString(int index, String value)
Inserts a string value into the list at a specified index.
Parameters:
index - the location where the value will be inserted into the list.
value - the string value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertInt(index, value):
"""
insertInt(int index, int value)
Inserts an int value into the list at a specified index.
Parameters:
index - the location where the value will be inserted into the list.
value - the int value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertDouble(index, value):
"""
insertDouble(int index, double value)
Inserts a double value into the list at a specified index.
Parameters:
index - the location where the value will be inserted into the list.
value - the double value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertBoolean(index, value):
"""
insertBoolean(int index, boolean value)
Inserts a boolean value into the list at a specified index.
Parameters:
index - the location where the value will be inserted into the list.
value - the boolean value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertId(index, value):
"""
insertId(int index, IDfId value)
Inserts an instance of an IDfId object into the list at a specified index.
Parameters:
index - the location where the object will be inserted into the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertTime(index, value):
"""
insertTime(int index, IDfTime value)
Inserts an instance of an IDfTime object into the list at a specified index.
Parameters:
index - the location where the object will be inserted into the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertValue(index, value):
"""
insertValue(int index, IDfValue value)
Inserts an instance of an IDfValue object into the list at a specified index.
Parameters:
index - the location where the object will be inserted into the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def insertList(index, value):
"""
insertList(int index, IDfList value)
Inserts an instance of an IDfList object into the list at a specified index.
Parameters:
index - the location where the object will be inserted into the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def get(index):
"""
get(int index)
Fetches an Object instance from the list at the specified index.
Parameters:
index - the location in the list where the Object will be fetched.
Returns:
an Object instance.
Throws:
DfException - if there is a bad index value
"""
return
def getString(index):
"""
getString(int index)
Fetches a string value from the list at the specified index.
Parameters:
index - the location in the list where the string value will be fetched.
Returns:
a string value.
Throws:
DfException - if there is a type mismatch
"""
return
def getInt(index):
"""
getInt(int index)
Fetches an int value from the list at the specified index.
Parameters:
index - the location in the list where the int value will be fetched.
Returns:
an int value.
Throws:
DfException - if there is a type mismatch
"""
return
def getDouble(index):
"""
getDouble(int index)
Fetches a double value from the list at the specified index.
Parameters:
index - the location in the list where the double value will be fetched.
Returns:
a double value.
Throws:
DfException - if there is a type mismatch
"""
return
def getBoolean(index):
"""
getBoolean(int index)
Fetches a boolean value from the list at the specified index.
Parameters:
index - the location in the list where the boolean value will be fetched.
Returns:
a boolean value.
Throws:
DfException - if there is a type mismatch
"""
return
def getId(index):
"""
getId(int index)
Fetches an instance of an IDfId object from the list at the specified index.
Parameters:
index - the location in the list where an instance of an IDfId object will be fetched.
Returns:
an instance of an IDfId object.
Throws:
DfException - if there is a type mismatch
"""
return
def getTime(index):
"""
getTime(int index)
Fetches an instance of an IDfTime object from the list at the specified index.
Parameters:
index - the location in the list where an instance of an IDfTime object will be fetched.
Returns:
an instance of an IDfTime object.
Throws:
DfException - if there is a type mismatch
"""
return
def getValue(index):
"""
getValue(int index)
Fetches an instance of an IDfValue object from the list at the specified index.
Parameters:
index - the location in the list where an instance of an IDfValue object will be fetched.
Returns:
an instance of an IDfValue object.
Throws:
DfException - if there is a type mismatch
"""
return
def getList(index):
"""
getList(int index)
Fetches an instance of an IDfList object from the list at the specified index.
Parameters:
index - the location in the list where an instance of an IDfList object will be fetched.
Returns:
an instance of an IDfList object.
Throws:
DfException - if there is a type mismatch
"""
return
def set(index, value):
"""
set(int index, Object value)
Adds an Object instance into the list at a specified index. The previous Object at that position is discarded.
Parameters:
index - the location where the object will be added to the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch, a null value, or a bad index
"""
return
def setString(index, value):
"""
setString(int index, String value)
Adds a string value into the list at a specified index. The previous value at that position is discarded.
Parameters:
index - the location where the value will be added to the list.
value - the string value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setInt(index, value):
"""
setInt(int index, int value)
Adds an int value into the list at a specified index. The previous value at that position is discarded.
Parameters:
index - the location where the value will be added to the list.
value - the int value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setDouble(index, value):
"""
setDouble(int index, double value)
Adds a double value into the list at a specified index. The previous value at that position is discarded.
Parameters:
index - the location where the value will be added to the list.
value - the double value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setBoolean(index, value):
"""
setBoolean(int index, boolean value)
Adds a boolean value into the list at a specified index. The previous value at that position is discarded.
Parameters:
index - the location where the value will be added to the list.
value - the boolean value to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setId(index, value):
"""
setId(int index, IDfId value)
Adds an instance of an IDfId interface into the list at a specified index. The previous object at that position is discarded.
Parameters:
index - the location where the object will be added to the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setTime(index, value):
"""
setTime(int index, IDfTime value)
Adds an instance of an IDfTime interface into the list at a specified index. The previous object at that position is discarded.
Parameters:
index - the location where the object will be added to the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setValue(index, value):
"""
setValue(int index, IDfValue value)
Adds an instance of an IDfValue interface into the list at a specified index. The previous object at that position is discarded.
Parameters:
index - the location where the object will be added to the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def setList(index, value):
"""
setList(int index, IDfList value)
Adds an instance of an IDfList interface into the list at a specified index. The previous object at that position is discarded.
Parameters:
index - the location where the object will be added to the list.
value - the object instance to add to the list.
Throws:
DfException - if there is a type mismatch
"""
return
def findIndex(value):
"""
findIndex(Object value)
Returns the index of the first occurrence of the Object in the list.
Parameters:
value - the object to search for in the list.
Returns:
the index of the first occurrence of the Object, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return
def findStringIndex(value):
"""
findStringIndex(String value)
Returns the index of the first occurrence of a string value in the list.
Parameters:
value - the string value to search for in the list.
Returns:
the index of the first occurrence of the string value, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findIntIndex(value):
"""
findIntIndex(int value)
Returns the index of the first occurrence of an int value in the list.
Parameters:
value - the int value to search for in the list.
Returns:
the index of the first occurrence of the int value, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findDoubleIndex(value):
"""
findDoubleIndex(double value)
Returns the index of the first occurrence of a double value in the list.
Parameters:
value - the double value to search for in the list.
Returns:
the index of the first occurrence of the double value, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findBooleanIndex(value):
"""
findBooleanIndex(boolean value)
Returns the index of the first occurrence of a boolean value in the list.
Parameters:
value - the boolean value to search for in the list.
Returns:
the index of the first occurrence of the boolean value, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findIdIndex(value):
"""
findIdIndex(IDfId value)
Returns the index of the first occurrence of an IDfId object in the list.
Parameters:
value - the IDfId object to search for in the list.
Returns:
the index of the first occurrence of the IDfId object, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findTimeIndex(value):
"""
findTimeIndex(IDfTime value)
Returns the index of the first occurrence of an IDfTime object in the list.
Parameters:
value - the IDfTime object to search for in the list.
Returns:
the index of the first occurrence of the IDfTime object, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findValueIndex(value):
"""
findValueIndex(IDfValue value)
Returns the index of the first occurrence of an IDfValue object in the list.
Parameters:
value - the IDfValue object to search for in the list.
Returns:
the index of the first occurrence of the IDfValue object, or -1 if it is not found.
Throws:
DfException - if an unexpected error occurs
"""
return int()
def findListIndex(value):
"""
findListIndex(IDfList value)
Returns the index
