Package | Description |
---|---|
com.documentum.com |
Provides an interface for accessing the DFC through OLE/COM.
|
com.documentum.fc.bpm | |
com.documentum.fc.client |
Provides classes and interfaces for managing sessions and manipulating data in the repository. |
com.documentum.fc.client.acs |
Provides classes and interfaces, related to distributed content transfer.
|
com.documentum.fc.client.aspect | |
com.documentum.fc.client.content | |
com.documentum.fc.client.fulltext | |
com.documentum.fc.client.search |
Provides classes and interfaces for constructing and running search queries against
multiple content repositories as well as external information sources (optional).
|
com.documentum.fc.client.search.filter |
This package contains interfaces to provide search services filters.
|
com.documentum.fc.common |
Provides classes and interfaces to utility functionality associated with all DFC objects.
|
com.documentum.fc.lifecycle |
Provides interfaces for defining logic on lifecycles.
|
com.documentum.operations |
Provides interfaces to common high-level client functionality,
such as functionality for checking in and checking out documents,
and checking out all the documents in a virtual document.
|
com.documentum.registry |
Provides interfaces and classes that manage Documentum
information on the client’s local system.
|
com.documentum.xml.xdql |
Provides interfaces and classes that allow querying of the docbase with
results returned as XML.
|
com.documentum.xml.xquery |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
IDfClientX.deserializeObject(java.lang.String image)
Restores the object from its serialized image.
|
java.lang.Object |
DfClientX.deserializeObject(java.lang.String image) |
IDfCancelCheckoutOperation |
IDfClientX.getCancelCheckoutOperation()
Factory method that constructs a new
IDfCancelCheckout object. |
IDfCancelCheckoutOperation |
DfClientX.getCancelCheckoutOperation() |
IDfCheckinOperation |
IDfClientX.getCheckinOperation()
Factory method that constructs a new
IDfCheckinOperation object for checking in one or more checked
out repository objects. |
IDfCheckinOperation |
DfClientX.getCheckinOperation() |
IDfCheckoutOperation |
IDfClientX.getCheckoutOperation()
Factory method that constructs a new
IDfCheckoutOperation object for checking in one or more
repository objects previously checked out. |
IDfCheckoutOperation |
DfClientX.getCheckoutOperation() |
IDfClientRegistry |
IDfClientX.getClientRegistry()
Factory method that constructs a new
IDfClientRegistry
object that provides access to the Docbase object information stored on
the local system. |
IDfClientRegistry |
DfClientX.getClientRegistry() |
IDfCopyOperation |
IDfClientX.getCopyOperation()
Factory method that constructs a new
IDfCopyOperation object. |
IDfCopyOperation |
DfClientX.getCopyOperation() |
IDfDeleteOperation |
IDfClientX.getDeleteOperation()
Factory method that constructs a new
IDfDeleteOperation object. |
IDfDeleteOperation |
DfClientX.getDeleteOperation() |
IDfDocbrokerClient |
IDfClientX.getDocbrokerClient()
Factory method that contructs a new
IDfDocbrokerClient instance. |
IDfDocbrokerClient |
DfClientX.getDocbrokerClient() |
IDfExportOperation |
IDfClientX.getExportOperation()
Factory method that constructs a new
IDfExportOperation object for exporting one or more repository
objects to the file system. |
IDfExportOperation |
DfClientX.getExportOperation() |
IDfFile |
IDfClientX.getFile(java.lang.String filePath)
Factory method that constructs a new
IDfFile object that
represents a file system file. |
IDfFile |
DfClientX.getFile(java.lang.String filePath) |
IDfFormatRecognizer |
IDfClientX.getFormatRecognizer(IDfSession session,
java.lang.String filePath,
java.lang.String suggestedFormat)
Factory method that constructs a new
IDfFormatRecognizer
object that is used to suggest what Docbase formats might be appropriate
for the specified file. |
IDfFormatRecognizer |
DfClientX.getFormatRecognizer(IDfSession session,
java.lang.String filePath,
java.lang.String suggestedFormat) |
IDfImportOperation |
IDfClientX.getImportOperation()
Factory method that constructs a new
IDfImportOperation object for importing one or more files into
the repository. |
IDfImportOperation |
DfClientX.getImportOperation() |
IDfClient |
IDfClientX.getLocalClient()
Factory method for an
IDfClient object. |
IDfClient |
DfClientX.getLocalClient() |
IDfClient |
IDfClientX.getLocalClient32()
Returns a DFC local client object that will call into DMCL32.dll for
backward compatibility with pre-4.0 Documentum servers.
|
IDfClient |
DfClientX.getLocalClient32() |
IDfFormatRecognizer |
IDfClientX.getMacFormatRecognizer(IDfSession session,
java.lang.String dataForkpath,
java.lang.String resourceForkPath,
java.lang.String suggestedFormat)
Factory method that constructs a new
IDfFormatRecognizer object that is used to suggest what Docbase
formats might be appropriate based on both the data and resource forks of a Macintosh file. |
IDfFormatRecognizer |
DfClientX.getMacFormatRecognizer(IDfSession session,
java.lang.String dataForkPath,
java.lang.String resForkPath,
java.lang.String suggestedFormat) |
IDfMoveOperation |
IDfClientX.getMoveOperation()
Factory method that constructs a new
IDfMoveOperation object. |
IDfMoveOperation |
DfClientX.getMoveOperation() |
IDfOperation |
IDfClientX.getOperation(java.lang.String operationName)
Deprecated.
As of DFC 5.3, replaced by one of the
get methods |
IDfOperation |
DfClientX.getOperation(java.lang.String operationName) |
IDfPredictiveCachingOperation |
IDfClientX.getPredictiveCachingOperation()
Factory method that constructs a new
IDfPredictiveCachingOperation object
for predictive content caching. |
IDfPredictiveCachingOperation |
DfClientX.getPredictiveCachingOperation() |
IDfValidationOperation |
IDfClientX.getValidationOperation()
Factory method that constructs a new
IDfValidationOperation object. |
IDfValidationOperation |
DfClientX.getValidationOperation() |
IDfVirtualDocument |
IDfClientX.getVirtualDocument(IDfSysObject rootObject,
java.lang.String lateBindingValue,
boolean followRootAssembly)
Returns a virtual document object where the provided
IDfSysObject is the
root object of the virtual document. |
IDfVirtualDocument |
DfClientX.getVirtualDocument(IDfSysObject rootObject,
java.lang.String lateBindingValue,
boolean followRootAssembly) |
IDfVirtualDocumentNode |
IDfClientX.getVirtualDocumentNodeFromToken(IDfSession session,
java.lang.String token)
Returns an interface to a node of a virtual document given a unique token
that represents the node in the virtual document tree.
|
IDfVirtualDocumentNode |
DfClientX.getVirtualDocumentNodeFromToken(IDfSession session,
java.lang.String token) |
IDfXMLTransformOperation |
IDfClientX.getXMLTransformOperation()
Factory method that constructs a new
IDfTransformOperation object for using XSLT to transform one or
more XML documents into another form, such as HTML, PDF, etc. |
IDfXMLTransformOperation |
DfClientX.getXMLTransformOperation() |
com.documentum.xml.xquery.IDfXQueryTargets |
IDfClientX.getXQueryTargets(int targetCategory)
Factory method that constructs a new
IDfXQueryTargets object. |
com.documentum.xml.xquery.IDfXQueryTargets |
DfClientX.getXQueryTargets(int targetCategory) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
IDfAttributeValueCondition.getAttributeName()
Returns the name of the attribute of the package component's data type that is to participate in
the relational operation with a constant value.
|
java.lang.String |
IDfXPathConditionEx.getDefaultXPathNamespace()
The default (ie. no prefix) namespace URI for the XPath expression.
|
java.lang.String |
IDfTransitionCondition.getObjectAlias()
The alias of the object upon which the transition condition is to be applied.
|
int |
IDfTransitionCondition.getRelationalOperator()
Returns an integer specifying which relational operator to use for this transition condition.
|
int |
IDfAttributeValueCondition.getRepeatingAttributeFlag()
Returns the repeating attribute flag that determines how a comparison is performed when the named
attribute is repeating.
|
IDfValue |
IDfAttributeValueCondition.getValue()
The value for use within the comparison in the form of an IDfValue instance.
|
java.lang.String |
IDfXPathCondition.getXPathExpression()
The XPath expression addressing a textual entity within a package component's primary content.
|
java.lang.String |
IDfXPathConditionEx.getXPathNamespace(java.lang.String prefix)
The namespace URI to which the given prefix refers within the XPath expression.
|
IDfProperties |
IDfXPathConditionEx.getXPathNamespaces()
A map of all the namespace prefixes and URIs defined for the XPath expression.
|
java.lang.String |
IDfXPathCondition.getXPathValue()
Gets the String value (formatted according to XSchema datatype) against which the runtime comparison will be made
|
java.lang.String |
IDfXPathCondition.getXSchemaDatatype()
The built-in XSchema datatype (for example, gDateTime) that determines how the String value
will be interpreted for the runtime comparison.
|
boolean |
IDfTransitionCondition.isValid()
Indicates if a transition condition is complete and has legitimate values.
|
void |
IDfXPathConditionEx.removeXPathNamespace(java.lang.String prefix)
Removes a namespace definition.
|
void |
IDfAttributeValueCondition.setAttributeName(java.lang.String name)
Sets the name of the attribute of the package component's data type that is to participate in
the comparison with a constant value.
|
void |
IDfAttributeValueCondition.setBooleanValue(boolean value)
Sets a boolean value for use within the comparison.
|
void |
IDfXPathConditionEx.setDefaultXPathNamespace(java.lang.String uri)
Defines the default (ie. no prefix) namespace URI for the XPath expression.
|
void |
IDfAttributeValueCondition.setDoubleValue(double value)
Sets a double value for use within the comparison.
|
void |
IDfAttributeValueCondition.setIdValue(IDfId value)
Sets an id value for use within the comparison.
|
void |
IDfAttributeValueCondition.setIntValue(int value)
Sets an integer value for use within the comparison.
|
void |
IDfTransitionCondition.setObjectAlias(java.lang.String name)
Set the alias of the object upon which the transition condition is
to be applied.
|
void |
IDfTransitionCondition.setRelationalOperator(int operator)
Sets an integer specifying which relational operator to use for this transition condition.
|
void |
IDfAttributeValueCondition.setRepeatingAttributeFlag(int flag)
Sets the repeating attribute flag to determine how a comparison is performed when the named
attribute is repeating.
|
void |
IDfAttributeValueCondition.setStringValue(java.lang.String value)
Sets a string value for use within the comparison.
|
void |
IDfAttributeValueCondition.setTimeValue(IDfTime value)
Sets a time value for use within the comparison.
|
void |
IDfAttributeValueCondition.setValue(IDfValue value)
Sets a value for use within the comparison in the form of an IDfValue instance.
|
void |
IDfXPathCondition.setXPathExpression(java.lang.String xpath)
Sets the XPath expression defining the value for runtime comparison.
|
void |
IDfXPathConditionEx.setXPathNamespace(java.lang.String prefix,
java.lang.String uri)
Defines a namespace referenced within the XPath expression.
|
void |
IDfXPathCondition.setXPathValue(java.lang.String value)
Sets the value (formatted according to XSchema datatype) against which the runtime comparison will be made.
|
void |
IDfXPathCondition.setXSchemaDatatype(java.lang.String datatype)
Sets the built-in XSchema datatype (for example, gDateTime) that determines how the String value
will be interpreted for the runtime comparison.
|
Modifier and Type | Class and Description |
---|---|
class |
DfACLException
An exception that occurs when operating on a IDfACL instance.
|
class |
DfAlreadyLinkedException |
class |
DfAspectOperationException |
class |
DfAttributeValueException |
class |
DfAuthenticationException
Signals a problem with authentication of an identity.
|
class |
DfContentAreaException |
class |
DfDborNotFoundException
This exception is used to indicate that the DBOR was not found
|
class |
DfDeadlockException |
class |
DfDocbaseUnreachableException |
class |
DfDocbrokerException |
class |
DfDuplicateAspectException |
class |
DfIdentityException
This exception is thrown when a specific docbase does not have an identity.
|
class |
DfIdNotFoundException
Thrown when a requested Docbase object can not be found.
|
class |
DfIOException
Signals that an I/O exception of some sort has occurred while communicating with the docbase.
|
class |
DfNameNotFoundException
Thrown when a requested Docbase object can not be found.
|
class |
DfNoMatchException
Thrown when a qualification failed to match an object.
|
class |
DfNonExistentAspectException |
class |
DfNoServersException |
class |
DfObjectNotFoundException
Thrown when a requested Docbase object can not be found.
|
class |
DfOutOfServerSessionsException |
class |
DfOutOfSessionsException |
class |
DfPathNotFoundException
Thrown when a requested Docbase object can not be found.
|
class |
DfPersistentObjectException |
class |
DfPreferenceException
An exception that occurs when operating on a IDfTypedObject instance.
|
class |
DfPrincipalException
An exception that signals a problem with principal authentication.
|
class |
DfRestrictedAccessException
Signals a restricted session.
|
class |
DfScopingException
DfScopingException class.
|
class |
DfServiceException
This class provides error information.
|
class |
DfServiceInstantiationException
This exception is thrown when a Business Object Service is not properly configured in DBOR (Documentum Business
Object registry) and the Java class cannot be instantiated.
|
class |
DfServiceNotFoundException
This exception is thrown when a Business Object Service is not configured in DBOR (Documentum Business Object
registry).
|
class |
DfSysObjectException
An exception that occurs when operating on a IDfSysObject instance.
|
class |
DfSysObjectSecurityException |
class |
DfTypedObjectException
An exception that occurs when operating on a IDfTypedObject instance.
|
class |
DfUserAliasSetNotFoundException |
class |
DfUserException |
class |
DfWorkflowException
Exceptions that occur when operating on workflow runtime objects including IDfWorkflow, IDfWorkitem, IDfPackage
|
class |
InvocationException |
Modifier and Type | Method and Description |
---|---|
void |
IDfWorkflow.abort()
Terminates a workflow.
|
void |
IDfBatchManager.abortBatch()
Abort the batch operation and roll back the batch transaction.
|
void |
IDfSession.abortTrans()
Closes an explicit database transaction and cancels any changes made since the call to
IDfSession.beginTrans() . |
void |
IDfSession.abortTransEx(IDfLocalTransaction tx)
abort the transaction specified by the IDfTransaction
|
void |
IDfWorkitem.acquire()
Acquires a work item for the current user.
|
void |
IDfRouter.acquire(int taskNumber)
Deprecated.
|
void |
IDfProcess.addActivity(java.lang.String actName,
IDfId actId,
java.lang.String actType,
int actPriority)
Adds an activity to the workflow definition.
|
void |
IDfSessionManagerConfig.addApplicationCode(java.lang.String value) |
IDfId |
IDfWorkitem.addAttachment(java.lang.String componentType,
IDfId componentId)
Adds an attachment to the workflow.
|
IDfId |
IDfWorkflow.addAttachment(java.lang.String componentType,
IDfId componentId)
Adds an attachment to the workflow.
|
void |
IDfVirtualDocument.addChangeDescription(int code,
IDfId objectId,
java.lang.String contextTag,
java.lang.String description)
Records a change made to a node.
|
IDfRelation |
IDfPersistentObject.addChildRelative(java.lang.String relationTypeName,
IDfId childId,
java.lang.String childLabel,
boolean isPermanent,
java.lang.String description)
Creates a Relation object.
|
void |
IDfActivity.addConditionRouteCase(java.lang.String routeCaseIdentifier,
IDfList conditions,
IDfList outputPorts)
Adds a route case to the activity.
|
IDfId |
IDfSysObject.addDigitalSignature(java.lang.String userName,
java.lang.String reason)
Create an audit trail entry that records the signing of a DfSysObject by a user.
|
void |
IDfDocbrokerClient.addDocbroker(java.lang.String hostName,
int portNumber)
Dynamically adds a connection broker to the list of known connection brokers.
|
void |
IDfAdminClient.addDocbroker(java.lang.String hostName,
int portNumber)
Dynamically adds a connection broker to the list of brokers known to DFC.
|
void |
IDfSessionManagerConfig.addDynamicGroup(java.lang.String value) |
void |
IDfSession.addDynamicGroup(java.lang.String groupName)
Adds the session user to the dynamic group for this session.
|
IDfId |
IDfSysObject.addESignature(java.lang.String userName,
java.lang.String password,
java.lang.String signatureJustification,
java.lang.String formatToSign,
java.lang.String hashAlgorithm,
java.lang.String preSignatureHash,
java.lang.String signatureMethodName,
java.lang.String applicationProperties,
java.lang.String passThroughArgument1,
java.lang.String passThroughArgument2)
Electronically sign a sysobject.
|
boolean |
IDfGroup.addGroup(java.lang.String groupName)
Adds a group to this group.
|
void |
IDfProcess.addLink(java.lang.String linkName,
java.lang.String linkSrcActivity,
java.lang.String linkSrcPortName,
java.lang.String linkDestActivity,
java.lang.String linkDstPortName)
Adds a link to a workflow definition.
|
IDfVirtualDocumentNode |
IDfVirtualDocument.addNode(IDfVirtualDocumentNode parentNode,
IDfVirtualDocumentNode insertAfterNode,
IDfId objectChronId,
java.lang.String binding,
boolean followAssembly,
boolean overrideLateBindingValue)
Adds a new node to the virtual document.
|
IDfVirtualDocumentNode |
IDfVirtualDocument.addNodeToNode(IDfVirtualDocumentNode parentNode,
IDfVirtualDocumentNode insertAfterNode,
IDfVirtualDocumentNode nodeToAdd)
Adds a node to another node in the display.
|
void |
IDfSysObject.addNote(IDfId targetId,
boolean keepPermanent)
Adds an annotation (the current IDfSysObject) to the target object.
|
void |
IDfNote.addNote(IDfId targetId,
boolean keepPermanent)
Adds an annotation (the current IDfSysObject) to the target object.
|
IDfId |
IDfWorkitem.addPackage(java.lang.String packageName,
java.lang.String packageType,
IDfList componentId)
Adds a package to a work item.
|
IDfId |
IDfWorkitem.addPackage(java.lang.String packageName,
java.lang.String packageType,
IDfList componentId,
IDfList componentName)
Adds a package to a work item.
|
IDfId |
IDfWorkflowBuilder.addPackage(java.lang.String startActivityName,
java.lang.String inputPortName,
java.lang.String packageName,
java.lang.String packageType,
java.lang.String noteText,
boolean notePersistent,
IDfList componentIds)
Adds a package to a start activity in the workflow.
|
IDfId |
IDfWorkflow.addPackage(java.lang.String startActivityName,
java.lang.String inputPortName,
java.lang.String packageName,
java.lang.String packageType,
java.lang.String noteText,
boolean notePersistent,
IDfList componentId)
Adds a package to a start activity in a workflow.
|
IDfId |
IDfWorkflow.addPackage(java.lang.String startActivityName,
java.lang.String inputPortName,
java.lang.String packageName,
java.lang.String packageType,
java.lang.String noteText,
boolean notePersistent,
IDfList componentId,
IDfList componentName)
Adds a package to a start activity in a workflow.
|
IDfId |
IDfWorkitem.addPackageEx(java.lang.String packageName,
java.lang.String packageType,
IDfList componentId,
IDfList componentName,
int skillLevel)
Adds a package to a work item and specifies a skill level for the package.
|
IDfId |
IDfWorkitem.addPackageEx(java.lang.String packageName,
java.lang.String packageType,
IDfList componentId,
int skillLevel)
Adds a package to a work item and specifies a skill level for the package.
|
IDfId |
IDfWorkflow.addPackageEx(java.lang.String startActivityName,
java.lang.String inputPortName,
java.lang.String packageName,
java.lang.String packageType,
java.lang.String noteText,
boolean notePersistent,
IDfList componentId,
IDfList componentName,
int skillLevel)
Adds a package to a start activity in the workflow and specifies a skill_level
for the package
You must be the workflow supervisor the workflow creator, or a user with at least
Sysadmin privileges to use this method.
|
IDfId |
IDfWorkflow.addPackageEx(java.lang.String startActivityName,
java.lang.String inputPortName,
java.lang.String packageName,
java.lang.String packageType,
java.lang.String noteText,
boolean notePersistent,
IDfList componentId,
int skillLevel)
Adds a package to a start activity in the workflow and specifies a skill_level
for the package
You must be the workflow supervisor the workflow creator, or a user with at least
Sysadmin privileges to use this method.
|
void |
IDfActivity.addPackageInfo(java.lang.String portName,
java.lang.String packageName,
java.lang.String packageType,
IDfId packageId,
java.lang.String packageLabel,
java.lang.String packageOperation)
Adds a package definition to a port in the activity.
|
void |
IDfActivity.addPackageInfoEx(java.lang.String portName,
java.lang.String packageName,
java.lang.String packageType,
IDfId packageId,
java.lang.String packageLabel,
java.lang.String packageOperation,
int packageFlag)
Adds a package definition to a port in the activity.
|
void |
IDfActivity.addPackageInfoEx(java.lang.String portName,
java.lang.String packageName,
java.lang.String packageType,
IDfId packageId,
java.lang.String packageLabel,
java.lang.String packageOperation,
int packageFlag,
int packageReportFlag)
Adds a package definition to a port in the activity.
|
void |
IDfWorkflow.addPackageToInitiateAct(java.lang.String packageName,
java.lang.String packageType,
IDfList componentId)
This funtion would add the package to the start activities linked with the initiate activity that has been
previously set by the setInitiateAct() API, if the package is defined on some input port of each start activity.
|
void |
IDfWorkflow.addPackageToInitiateAct(java.lang.String packageName,
java.lang.String packageType,
IDfList componentId,
java.lang.String noteText,
boolean persistentNote,
int skillLevel)
This funtion would add the package to the start activities linked with the initiate activity that has been
previously set by the setInitiateAct() API, if the package is defined on some input port of each start activity.
|
IDfRelation |
IDfPersistentObject.addParentRelative(java.lang.String relationTypeName,
IDfId parentId,
java.lang.String childLabel,
boolean isPermanent,
java.lang.String description)
Creates a Relation object.
|
void |
IDfActivity.addPerformerCondition(java.lang.String conditionName,
java.lang.String condition,
IDfList performers)
Adds a performer case to the activity.
|
void |
IDfActivity.addPort(java.lang.String portName,
java.lang.String portType)
Adds a port to the activity.
|
void |
IDfActivity.addPostTimerAction(IDfId action,
int minutes)
Establishes a timer at the end of the series.
|
void |
IDfActivity.addPreTimerAction(IDfId action,
int minutes)
Establishes a timer at the end of the series.
|
IDfId |
IDfSysObject.addReference(IDfId folderId,
java.lang.String bindingCondition,
java.lang.String bindingLabel)
Add a reference to the object in another folder.
|
void |
IDfSysObject.addRendition(java.lang.String fileName,
java.lang.String formatName)
Adds a new rendition to the object.
|
void |
IDfSysObject.addRenditionEx(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
java.lang.String storageName,
boolean atomic)
This is the extended method for adding a new rendition to the object..
|
void |
IDfSysObject.addRenditionEx2(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
java.lang.String storageName,
boolean atomic,
boolean keep,
boolean batch)
This is the extended method for adding a new rendition to the object..
|
void |
IDfSysObject.addRenditionEx3(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
java.lang.String storageName,
boolean atomic,
boolean keep,
boolean batch,
java.lang.String otherFileName)
This is the extended method for adding a new rendition to the object..
|
void |
IDfActivity.addRouteCase(java.lang.String routeCaseIdentifier,
java.lang.String condition,
IDfList outputPorts)
Adds a route case to the activity.
|
void |
IDfClient.addUnavailableAcsServer(java.lang.String urlString)
Deprecated.
use IDfAcsClient.addUnavailableAcsServer()
|
void |
DfClient.addUnavailableAcsServer(java.lang.String urlString) |
boolean |
IDfGroup.addUser(java.lang.String userName)
Adds a user to this group.
|
IDfSession |
IDfClient.adoptDMCLSession(java.lang.String dmclSessionId)
Deprecated.
session adoption is no longer useful without a separate DMCL
|
IDfSession |
DfClient.adoptDMCLSession(java.lang.String dmclSessionId) |
IDfList |
IDfSession.apiDesc(java.lang.String api)
Deprecated.
|
boolean |
IDfSession.apiExec(java.lang.String cmd,
java.lang.String args)
Deprecated.
|
boolean |
IDfPersistentObject.apiExec(java.lang.String cmd,
java.lang.String args)
Deprecated.
DMCL passthrough should not be used anymore
|
java.lang.String |
IDfSession.apiGet(java.lang.String cmd,
java.lang.String args)
Deprecated.
|
java.lang.String |
IDfPersistentObject.apiGet(java.lang.String cmd,
java.lang.String args)
Deprecated.
DMCL passthrough should not be used anymore
|
java.io.ByteArrayInputStream |
IDfSession.apiGetBytes(java.lang.String cmd,
java.lang.String args,
java.lang.String buf,
java.lang.String buflen,
int length)
Deprecated.
|
boolean |
IDfSession.apiSet(java.lang.String cmd,
java.lang.String args,
java.lang.String value)
Deprecated.
|
boolean |
IDfPersistentObject.apiSet(java.lang.String cmd,
java.lang.String args,
java.lang.String value)
Deprecated.
DMCL passthrough should not be used anymore
|
boolean |
IDfSession.apiSetBytes(java.lang.String cmd,
java.lang.String args,
java.io.ByteArrayOutputStream content)
Deprecated.
|
void |
IDfProcess.appendActPerformer(int actPerfRule,
java.lang.String actPerfFrom,
java.lang.String actPerfTo)
Append values to parallel attributes: act_performer_rule/act_performer_from/act_performer_to
|
int |
IDfAliasSet.appendAlias(java.lang.String name,
java.lang.String value,
int category,
int userCategory,
java.lang.String description)
Appends an alias to the alias set.
|
void |
IDfTypedObject.appendBoolean(java.lang.String attributeName,
boolean value)
Appends a boolean value to a repeating attribute.
|
void |
IDfSysObject.appendContent(java.io.ByteArrayOutputStream content)
Appends new content to an object.
|
void |
IDfSysObject.appendContentEx(java.io.ByteArrayOutputStream content,
boolean other)
Appends new content to an object.
|
void |
IDfTypedObject.appendDouble(java.lang.String attributeName,
double value)
Appends a double value to a repeating attribute.
|
void |
IDfSysObject.appendFile(java.lang.String fileName)
Appends new content to an object.
|
void |
IDfSysObject.appendFileEx(java.lang.String fileName,
java.lang.String otherFileName)
Appends new content to an object.
|
void |
IDfTypedObject.appendId(java.lang.String attributeName,
IDfId value)
Appends an ID value to a repeating attribute.
|
void |
IDfTypedObject.appendInt(java.lang.String attributeName,
int value)
Appends an integer value to a repeating attribute.
|
int |
IDfPackage.appendNote(java.lang.String text,
boolean persistent)
Adds a note to a package.
|
void |
IDfPackage.appendNoteEx(IDfId annotationId,
boolean persistent)
Adds a note to a package.
|
IDfId |
IDfSysObject.appendPart(IDfId componentId,
java.lang.String versionLabel,
boolean useNodeVerLabel,
boolean followAssembly,
int copyChild)
Appends a document as the last virtual document child of the object.
|
int |
IDfPolicy.appendState()
Append a new state to this lifecycle.
|
void |
IDfTypedObject.appendString(java.lang.String attributeName,
java.lang.String value)
Appends a string value to a repeating attribute.
|
int |
IDfRouter.appendTask()
Deprecated.
|
void |
IDfTypedObject.appendTime(java.lang.String attributeName,
IDfTime value)
Appends a date/time value to a repeating attribute.
|
void |
IDfTypedObject.appendValue(java.lang.String attributeName,
IDfValue value)
Appends a value stored in an IDfValue object to a repeating attribute.
|
IDfCollection |
IDfSession.apply(java.lang.String objId,
java.lang.String functionName,
IDfList args,
IDfList dataType,
IDfList values)
Calls the server API Apply method.
|
void |
IDfSysObjectRetention.applyRetention(IDfId retainerId)
Places object under retention by the specified dm_retainer object.
|
IDfId |
IDfSession.archive(java.lang.String predicate,
java.lang.String operatorName,
int priority,
boolean sendMail,
IDfTime dueDate)
Queues an archive request to the repository operator.
|
boolean |
IDfSysObject.areAttributesModifiable()
Returns whether this object's attributes can be modified.
|
boolean |
IDfVirtualDocumentNode.areChildrenCompound()
Indicates whether users can add, remove, or reorder the children of this
node through VDM.
|
IDfCollection |
IDfSysObject.assemble(IDfId virtualDocId,
int interruptFreq,
java.lang.String qualification,
java.lang.String nodesortList)
Creates an assembly and associates it with the object.
|
void |
IDfVirtualDocumentNode.assemble(IDfSysObject object)
Creates an assembly for the node.
|
void |
IDfSession.assume(IDfLoginInfo loginInfo)
Gives ownership of the session to a new user.
|
IDfVirtualDocument |
IDfSysObject.asVirtualDocument(java.lang.String lateBindingValue,
boolean followRootAssembly)
Returns a virtual document representation of the object.
|
void |
IDfSysObject.attachPolicy(IDfId policyId,
java.lang.String state,
java.lang.String scope)
Attaches a business policy object to the object.
|
void |
IDfSession.authenticate(IDfLoginInfo loginInfo)
Validates credentials without returning a new session.
|
void |
IDfClient.authenticate(java.lang.String docbaseName,
IDfLoginInfo loginInfo)
Validates a username/password combination without returning a new session.
|
void |
DfClient.authenticate(java.lang.String docbaseName,
IDfLoginInfo loginInfo) |
IDfScope |
IDfSessionScopeManager.beginScope(boolean bNested)
Opens an explicit scope boundary.
|
IDfScope |
IDfScopeManager.beginScope(boolean bNested)
Opens an explicit scope boundary.
|
void |
IDfSession.beginTrans()
Opens an explicit database transaction.
|
IDfLocalTransaction |
IDfSession.beginTransEx()
begin a nested transaction
|
void |
IDfSysObject.bindFile(int pageNumber,
IDfId srcId,
int srcPageNumber)
Binds content associated with an object to another object.
|
IDfId |
IDfSysObject.branch(java.lang.String versionLabel)
Creates and checks out a new version of an object.
|
boolean |
IDfVirtualDocumentNode.canBeRemoved()
Indicates whether the node can be removed from its parent.
|
boolean |
IDfVirtualDocumentNode.canBeRestructured()
Indicates whether the node can be restructured.
|
void |
IDfSysObject.cancelCheckout()
Removes an intention lock without saving any changes that may have been made
to the locked object.
|
void |
IDfSysObject.cancelCheckoutEx(boolean sendMail,
java.lang.String compoundValue,
java.lang.String specialValue)
This is the extended method that removes an intention lock without
saving any changes that may have been made to the locked object.
|
void |
IDfSysObject.cancelScheduledDemote(IDfTime scheduleDate)
This will cancel the scheduled demote of the sysobject at the date/time
specifed by
scheduleDate . |
void |
IDfSysObject.cancelScheduledPromote(IDfTime scheduleDate)
This will cancel the scheduled promote for the date/time specified in the
scheduleDate argument. |
void |
IDfSysObject.cancelScheduledResume(IDfTime schedule)
This will cancel a scheduled resume of the sysobject for a certain date/time.
|
void |
IDfSysObject.cancelScheduledSuspend(IDfTime scheduleDate)
This method can be used to cancel a scheduled suspend of the sysobject at a
date/time.
|
boolean |
IDfVersionPolicy.canCheckinFromFile()
Indicates whether the object's content file can be overwritten by
an external file when the object is checked in to the repository.
|
boolean |
IDfSysObject.canDemote()
Returns whether the object can be demoted from the current state.
|
boolean |
IDfFormat.canIndex()
Indicates if a format can be full-text indexed.
|
boolean |
IDfSysObject.canPromote()
Returns whether the sysobject can be promoted from
current state to the next state.
|
boolean |
IDfSysObject.canResume()
Returns whether the sysobject can be resumed from an exception state.
|
boolean |
IDfSysObject.canSuspend()
Returns whether the sysobject can suspend from its current state to
the exception state.
|
boolean |
IDfSysObjectRetention.canSwapRetainer(IDfId oldRetainerId,
IDfId newRetainerId) |
boolean |
IDfVersionPolicy.canVersion(int toVersion)
Tests whether an object may be saved as the next major, minor, branch,
or same version.
|
boolean |
IDfVirtualDocumentNode.causesCycle()
Indicates whether the node's object ID matches that of any of its
parents in the virtual document hierarchy.
|
void |
IDfUser.changeHomeDocbase(java.lang.String userName,
boolean isImmediate)
Change the home repository of this user.
|
void |
IDfSession.changePassword(java.lang.String oldPasswd,
java.lang.String newPasswd)
Changes a password.
|
void |
IDfRetainer.changeRetentionStatus(int retentionStatus)
This call changes the status of the dm_retainer object.
|
com.documentum.fc.client.DormantStatus |
IDfSession.checkDormantStatus()
Checks the status of the server to which this session is connected
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
com.documentum.fc.client.DormantStatus |
IDfSession.checkDormantStatus(boolean allServersForThisDocbase)
Checks whether a server or docbase is dormant or not
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
IDfId |
IDfSysObject.checkin(boolean keepLock,
java.lang.String versionLabels)
Creates a new version of this object and removes the lock
from the previous version.
|
IDfId |
IDfSysObject.checkinEx(boolean keepLock,
java.lang.String versionLabels,
java.lang.String oldCompoundArchValue,
java.lang.String oldSpecialAppValue,
java.lang.String newCompoundArchValue,
java.lang.String newSpecialAppValue)
This is the extended method for checkin.
|
void |
IDfSysObject.checkout()
Places a lock on the object.
|
IDfId |
IDfSysObject.checkoutEx(java.lang.String versionLabel,
java.lang.String compoundArchValue,
java.lang.String specialAppValue)
Places a lock on the object.
|
void |
IDfScopeManager.clearDefaultScope(com.documentum.fc.client.ScopeBoundary boundary)
Removes one default scoping policy.
|
void |
IDfSessionScopeManager.clearScopes()
Pops all the scopes from the scope stack.
|
void |
IDfScopeManager.clearScopes()
Pops all the scopes from the scope stack.
|
void |
IDfCollection.close()
Closes a collection object.
|
void |
IDfBatchManager.closeBatch()
Flush the batch, commit the transaction, and close the batch.
|
IDfCollection |
IDfSession.collectMetrics(java.util.List<java.lang.String> metricsToCollect)
This methods indicates to the server to collect the metrics that have been passed in
to this method.
|
IDfCollection |
IDfSession.collectMetrics(java.util.List<java.lang.String> metricsToCollect,
java.lang.String outputFormat)
This methods indicates to the server to collect the metrics that have been passed in
to this method.
|
void |
IDfBatchManager.commitBatch()
Flush the batch data into the repository and commit the transaction for the batch.
|
void |
IDfSession.commitTrans()
Commits all changes made after a
IDfSession.beginTrans() method call. |
void |
IDfSession.commitTransEx(IDfLocalTransaction tx)
commit the transaction specified by the IDfLocalTransaction
|
void |
IDfWorkitem.complete()
Marks a work item as finished.
|
void |
IDfWorkitem.completeEx(int returnValue,
java.lang.String execOSError,
IDfId execResultId)
Marks the work item as complete.
|
void |
IDfWorkitem.completeEx2(int returnValue,
java.lang.String execOSError,
IDfId execResultId,
int userTime,
double userCost)
Marks the work item as complete.
|
IDfId |
IDfAuditTrailManager.createAudit(IDfId objectId,
java.lang.String event,
java.lang.String[] stringArgs,
IDfId[] idArgs)
Creates an audit trail entry for application events.
|
java.lang.String |
IDfClient.decryptText(java.lang.String s1,
java.lang.String s2)
Deprecated.
|
java.lang.String |
DfClient.decryptText(java.lang.String s1,
java.lang.String s2) |
void |
IDfWorkitem.delegateTask(java.lang.String user)
Delegates the work item to someone else.
|
void |
IDfLightObject.dematerialize()
Turn a materialized lightobject back into an unmaterialized lightobject
by reparenting to the original shared parent.
|
void |
IDfSysObject.demote(java.lang.String state,
boolean toBase)
This method will demote the sysobject from its current normal state to the
previous normal state, or to the base state if the
toBase
parameter is set to true . |
void |
IDfSession.dequeue(IDfId stampId)
Removes items from an inbox that were placed there using the
queue method. |
void |
IDfSession.dequeueAll()
Removes all items from an inbox that were placed there using the
queue method. |
java.lang.String |
IDfSession.describe(java.lang.String type,
java.lang.String objType)
Describes the attributes of a type or registered table.
|
void |
IDfPersistentObject.destroy()
Removes the object from the Documentum server.
|
void |
IDfACL.destroyACL(boolean force)
Removes an ACL object from a repository.
|
void |
IDfSysObject.destroyAllVersions()
Destroys all versions of the object.
|
void |
IDfSysObject.detachPolicy()
Detaches an existing business policy object from the object.
|
boolean |
IDfSession.disableSaveInDormantState()
Disables save operation for dormant state.
|
void |
IDfVirtualDocumentNode.disassemble()
Disassembles an assembly.
|
void |
IDfSysObject.disassemble()
Disassembles the assembly associated with the object.
|
void |
IDfSession.disconnect()
Disconnects the DFC session.
|
boolean |
IDfVirtualDocumentNode.doesSelectedVersionMatchBinding()
Indicates whether the currently displayed node object matches the
defined binding for the node.
|
java.lang.String |
IDfTypedObject.dump()
Lists an object's attributes and their values.
|
boolean |
IDfSession.enableSaveInDormantState()
Enables save operation for dormant state.
|
void |
IDfSessionScopeManager.enableServerScope(boolean enable)
Enables or disables server-side scoping.
|
java.lang.String |
IDfClient.encryptPassword(java.lang.String password)
Encrypts a password.
|
java.lang.String |
DfClient.encryptPassword(java.lang.String password) |
java.lang.String |
IDfClient.encryptText(java.lang.String s1,
java.lang.String s2)
Deprecated.
|
java.lang.String |
DfClient.encryptText(java.lang.String s1,
java.lang.String s2) |
void |
IDfRouter.end()
Deprecated.
|
void |
IDfSessionScopeManager.endScope()
Closes the explicit scope boundary.
|
void |
IDfScopeManager.endScope()
Closes the explicit scope boundary.
|
java.util.Enumeration |
IDfTypedObject.enumAttrs()
Returns an enumeration of IDfAttr objects.
|
java.util.Enumeration |
IDfClient.enumSharedSessions(java.lang.String key)
Deprecated.
use
IDfSessionManager instead for session sharing |
java.util.Enumeration |
DfClient.enumSharedSessions(java.lang.String key) |
java.lang.String |
IStorageRuleEvaluator.evaluate(IDfSysObject sysObj,
com.documentum.fc.client.DfContentInfo contentInfo,
IDfSession session,
java.lang.Object obj)
This method is used to evaluate the rules in the policy.
|
void |
IDfWorkflow.execute()
Starts a workflow.
|
IDfCollection |
IDfQuery.execute(IDfSession session,
int queryType)
Executes a DQL query.
|
java.lang.String |
IDfSession.exportTicketKey(java.lang.String password)
Returns the login ticket key of the repository.
|
boolean |
IDfPersistentObject.fetch(java.lang.String typeNameIgnored)
Fetches this object from the repository without placing a lock on the object.
|
boolean |
IDfPersistentObject.fetchWithCaching(java.lang.String currencyCheckValue,
boolean usePersistentCache,
boolean useSharedCache)
Fetches this object from the repository without placing a lock on the object.
|
IDfVirtualDocumentNode |
IDfVirtualDocument.find(IDfVirtualDocumentNode startNode,
java.lang.String searchString,
java.lang.String attributeList,
int flags)
Returns the node corresponding to a specified search string.
|
int |
IDfAliasSet.findAliasIndex(java.lang.String name)
Returns the index position of an alias in the alias set.
|
int |
IDfTypedObject.findAttrIndex(java.lang.String attributeName)
Returns the position of an attribute in the list of attributes that belong to this object.
|
int |
IDfTypedObject.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 |
IDfTypedObject.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 |
IDfTypedObject.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 |
IDfTypedObject.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.
|
IDfSession |
IDfClient.findSession(java.lang.String sessionId)
Returns an existing DFC session using a DFC session ID.
|
IDfSession |
DfClient.findSession(java.lang.String sessionId) |
int |
IDfTypedObject.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 |
IDfTypedObject.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 |
IDfType.findTypeAttrIndex(java.lang.String attrName)
Returns the index of an attribute.
|
int |
IDfTypedObject.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.
|
void |
IDfSession.flush(java.lang.String flushType,
java.lang.String cacheKey)
Removes cached queries from the client's query caches, ACLs and Group objects from the session cache, and type
information from the data dictionary cache.
|
void |
IDfBatchManager.flushBatch()
Flush the batch data into the repository.
|
void |
IDfSession.flushCache(boolean discardChanged)
Removes objects from the server and client caches.
|
void |
IDfSession.flushCachedQuery(java.lang.String dqlQuery)
Remove the specified query from the query cache.
|
void |
IDfSession.flushEx(java.lang.String flushType,
java.lang.String cacheKey,
boolean resetChangeBit,
boolean includeSubtypes)
Removes cached queries from the client's query caches, ACLs and Group objects from the session cache, and type
information from the data dictionary cache.
|
void |
IDfSession.flushGlobalCache(java.lang.String cacheName)
Removes objects from a global server cache.
|
void |
IDfSession.flushObject(IDfId objectId)
Remove the specified object from the cache.
|
void |
IDfRouter.force(int taskNumber,
java.lang.String message)
Deprecated.
|
void |
IDfRouter.forward(int currentTask,
IDfList additionalTask,
java.lang.String message)
Deprecated.
|
void |
IDfSysObject.freeze(boolean freezeComponents)
Marks an object as unchangeable (and optionally its components),
if the object is a virtual document.
|
IDfTime |
IDfPackage.getAcceptanceDate()
Returns the acceptance date, which identifies when a package arrived and was
accepted by an input port.
|
IDfTime |
IDfSysObject.getAccessDate()
Returns the date the content of this object was last accessed.
|
java.lang.String |
IDfSysObject.getAccessorApplicationPermit(int index)
Returns the application permit assigned to a user or group.
|
java.lang.String |
IDfACL.getAccessorApplicationPermit(int index)
Returns the application permit assigned to a user or group.
|
int |
IDfSysObject.getAccessorCount()
Returns the number of users or groups for whom some level of access is defined for the object.
|
int |
IDfACL.getAccessorCount()
Returns the number of users and groups referenced in an ACL object.
|
java.lang.String |
IDfSysObject.getAccessorName(int index)
Returns the list of users and groups for whom some level of access is defined for the object.
|
java.lang.String |
IDfACL.getAccessorName(int index)
Returns the name of an individual user, group or alias in an ACL object.
|
java.lang.String |
IDfSysObject.getAccessorPermit(int index)
Returns the permit levels assigned to each user or group using the computed attribute _accessor_name.
|
int |
IDfACL.getAccessorPermit(int index)
Returns the basic permission level granted to a user or group.
|
int |
IDfSysObject.getAccessorPermitType(int index)
Returns the permit type assigned to each user or group using the computed attribute _accessor_name.
|
int |
IDfACL.getAccessorPermitType(int index)
Identifies the type of permission granted an accessor in the ACL.
|
int |
IDfSysObject.getAccessorXPermit(int index)
Returns the extended permission levels of the specified user or group using the computed attribute
_accessor_name.
|
int |
IDfACL.getAccessorXPermit(int index)
Returns extended permissions granted to a user or group.
|
java.lang.String |
IDfSysObject.getAccessorXPermitNames(int index)
Retrieves the extended permissions, in upper case and separated by a comma, that are assigned to each user or
group.
|
java.lang.String |
IDfACL.getAccessorXPermitNames(int index)
Returns the extended permissions in string form assigned to a user or group.
|
IDfACL |
IDfSysObject.getACL()
Returns an ACL associated with the object.
|
IDfACL |
IDfSession.getACL(java.lang.String aclDomain,
java.lang.String aclName)
Returns an ACL object.
|
int |
IDfACL.getACLClass()
Returns the ACL class value.
|
java.lang.String |
IDfUser.getACLDomain()
Returns the domain of the ACL associated with a user.
|
java.lang.String |
IDfSysObject.getACLDomain()
Returns the domain of the ACL associated with this user.
|
java.lang.String |
IDfUser.getACLName()
Returns the name of the ACL associated with a user.
|
java.lang.String |
IDfSysObject.getACLName()
Returns the name of the associated ACL.
|
boolean |
IDfSysObject.getAclRefValid()
Indicates whether the values in _accessor_name and _accessor_permit have been saved to the repository using the
computed attribute _acl_ref_valid.
|
java.lang.String |
IDfQueueItem.getAContentType()
Returns the content type of the routed object.
|
IDfEnumeration |
IDfSysObject.getAcsRequests(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
IDfAcsTransferPreferences transferPreferences)
Returns an
IDfEnumeration object containing a list of IDfAcsRequest objects. |
IDfTypedObject |
IDfDocbrokerClient.getAcsServerMap(java.lang.String docbaseName)
Returns information about the ACS servers that are known to the set of connection brokers
currently configured for this IDfDocbrokerClient instance.
|
IDfTypedObject |
IDfDocbrokerClient.getAcsServerMapFromSpecificDocbroker(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the ACS servers that are known to a specific connection broker.
|
java.lang.String |
IDfProcess.getActChooseBy(int index)
Returns the act_choose_by attribute value at the specified index position.
|
int |
IDfProcess.getActChooseByCount()
Returns the number of values in the act_choose_by attribute.
|
java.lang.String |
IDfProcess.getActChooseFor(int index)
Returns the act_choose_for attribute value at the specified index position.
|
int |
IDfProcess.getActChooseForCount()
Returns the number of values in the act_choose_for attribute.
|
java.lang.String |
IDfProcess.getActChooseName(int index)
Returns the act_choose_name attribute value at the specified index.
|
int |
IDfProcess.getActChooseNameCount()
Returns the number of values in the act_choose_name attribute.
|
IDfId |
IDfWorkitem.getActDefId()
Returns the object ID of the activity definition whose runtime instance
generated the work item.
|
IDfId |
IDfWorkflow.getActDefId(int valueIndex)
Returns the object ID of an activity's definition.
|
int |
IDfWorkflow.getActErrorno(int valueIndex)
Returns the error number for a failed activity operation.
|
IDfId |
IDfPolicy.getActionObjectId(int index)
Return the attribute action_object_id value at the specified index.
|
int |
IDfPolicy.getActionObjectIdCount()
Return the number of attribute action_object_id values for this policy.
|
IDfActivity |
IDfWorkitem.getActivity()
Returns the work item's corresponding activity object.
|
int |
IDfWorkflow.getActivityCount()
Returns the number of activity instances in the workflow.
|
int |
IDfProcess.getActivityCount()
Returns the number of activities in the workflow.
|
IDfId |
IDfProcess.getActivityDefId(int actIndex)
Returns the object ID of an activity's definition.
|
IDfId |
IDfProcess.getActivityIdByName(java.lang.String actName)
Given an activity name, return the id of the activity.
|
java.lang.String |
IDfProcess.getActivityName(int actIndex)
Returns an activity name.
|
int |
IDfProcess.getActivityPriority(int actIndex)
Returns an activity's priority.
|
int |
IDfProcess.getActivityType(int actIndex)
Returns an activity's type.
|
int |
IDfProcess.getActivityTypeByName(java.lang.String actName)
Given an activity name, return the type of the activity.
|
java.lang.String |
IDfWorkflow.getActName(int valueIndex)
Returns the name of an activity.
|
int |
IDfProcess.getActPerformerCount()
Return the number of entries of the parallel attributes:
act_performer_rule/act_performer_from/act_performer_to
|
int |
IDfWorkitem.getActSeqno()
Returns the sequence number of the activity with which the work item is associated.
|
int |
IDfPackage.getActSeqno()
Returns the sequence number (r_act_seqno) of the activity in which the package
is being handled.
|
int |
IDfWorkflow.getActSeqno(int valueIndex)
Returns the sequence number of an activity.
|
int |
IDfWorkflow.getActState(int valueIndex)
Returns the state of an activiity.
|
IDfTime |
IDfQueueItem.getActualStartDate()
Returns the date on which work on the item actually started.
|
java.lang.String |
IDfValueAssistance.getActualValue(java.lang.String displayValue)
Return the possible actual value mapped to the specified
displayValue . |
int |
IDfRetainer.getAgingMethod()
Returns the dm_retainer.aging_method value.
|
int |
IDfAliasSet.getAliasCategory(int index)
Returns the category of the alias in the specified index position
in this alias set.
|
int |
IDfAliasSet.getAliasCount()
Returns the number of aliases in the alias set.
|
java.lang.String |
IDfAliasSet.getAliasDescription(int index)
Returns the description of the alias at the
specified index position in this alias set.
|
java.lang.String |
IDfAliasSet.getAliasName(int index)
Returns the alias name at the specified index in the list of
aliases for the alias set scope.
|
java.lang.String |
IDfUser.getAliasSet()
Returns the name of the user's default alias set.
|
java.lang.String |
IDfSysObject.getAliasSet()
Returns the symbolic name of the policy alias set.
|
java.lang.String |
IDfSession.getAliasSet()
Returns the alias set name of this session config object.
|
IDfId |
IDfWorkflow.getAliasSetId()
Returns the alias set object id for the workflow instance.
|
IDfId |
IDfUser.getAliasSetId()
Returns the object ID of the user's default alias set.
|
IDfId |
IDfSysObject.getAliasSetId()
Returns the position of alias-binding scope specified in the associated policy object.
|
IDfId |
IDfGroup.getAliasSetId()
Returns the alias set object id of the group.
|
IDfId |
IDfPolicy.getAliasSetIds(int index)
Return the alias_set_ids value at the specified index.
|
int |
IDfPolicy.getAliasSetIdsCount()
Return the number of attribute allias_set_ids values for this policy.
|
int |
IDfAliasSet.getAliasUserCategory(int index)
Returns the user category of the alias at the specified index
position in the alias set.
|
java.lang.String |
IDfAliasSet.getAliasValue(int index)
Returns the value corresponding to the alias at the specified index
in this alias set.
|
IDfList |
IDfAuditTrailManager.getAllEvents()
Gets a list of all the events(String) available in the repository.
|
IDfList |
IDfPolicy.getAllIncludedTypes()
Retun an IDfList that includes the complete list of types for objects that
can be attached to this policy.
|
IDfEnumeration |
IDfClient.getAllNetworkLocations(java.lang.String locale)
Deprecated.
use IDfAcsClient.getAllNetworkLocations()
|
IDfEnumeration |
DfClient.getAllNetworkLocations(java.lang.String locale) |
boolean |
IDfPolicy.getAllowAttach(int index)
Return the attribute allow_attach value at the specified index.
|
int |
IDfPolicy.getAllowAttachCount()
Return the number of attribute allow_attach values for this policy.
|
boolean |
IDfPolicy.getAllowDemote(int index)
Return the attribute allow_demote value at the specified index.
|
int |
IDfPolicy.getAllowDemoteCount()
Return the number of attribute allow_demote values for this policy.
|
boolean |
IDfPolicy.getAllowSchedule(int index)
Return the attribute allow_schedule value at the specified index.
|
int |
IDfPolicy.getAllowScheduleCount()
Return the number of attribute allow_schedule values for this policy.
|
IDfCollection |
IDfWorkitem.getAllPackages(java.lang.String additionalAttributes)
Returns a query result collection containing the following attributes:
String documentIDs object ID's of documents, separated by commas
String r_package_name
String r_packageType
String i_package_oprtn
IDfId r_note_id
This differs from getPackages by returning both visible and invisible packages.
|
java.lang.String |
IDfTypedObject.getAllRepeatingStrings(java.lang.String attributeName,
java.lang.String separator)
Returns all the values stored in a repeating attribute as a single string.
|
java.lang.String |
IDfGroup.getAllUsersNames(int index)
Returns the name (at a specified index) from all users in a group object, including users that belong to group
objects contained within this group object.
|
int |
IDfGroup.getAllUsersNamesCount()
Returns the number of users in a group object, including users that belong to group objects contained within this
group object.
|
java.lang.String |
IDfFolder.getAncestorId(int index)
Returns the object ID (as a string) of all the folders or cabinets that contain, directly or indirectly, this
folder.
|
int |
IDfFolder.getAncestorIdCount()
Returns the number of folder objects that contain, directly or indirectly, this folder.
|
IDfId |
IDfSysObject.getAntecedentId()
Returns the object id of the object's parent.
|
IDfList |
IDfAuditTrailManager.getApplicableEvents(IDfId objectId)
Gets a list of applicable events(String) for the object.
|
java.lang.String |
IDfSession.getApplicationToken(java.lang.String userName,
java.lang.String scope,
int timeout,
java.lang.String appId,
boolean machineOnly)
Acquires an application access control token.
|
java.lang.String |
IDfClient.getApplicationTokenDiagnostics(java.lang.String applicationToken)
Return details extracted from an applicationToken.
|
java.lang.String |
DfClient.getApplicationTokenDiagnostics(java.lang.String applicationToken) |
java.lang.String |
IDfSysObject.getApplicationType()
Returns the a_application_type attribute of the object.
|
IDfId |
IDfPolicy.getAppValidationId()
Return the attribute app_validation_id value for this policy.
|
java.lang.String |
IDfPolicy.getAppValidationVer()
Return the attribute app_validation_ver value for this policy.
|
IDfModuleDescriptor |
IDfLocalModuleRegistry.getAspectDescriptor(java.lang.String aspectName)
Gets the meta data for the Aspect mapped to the aspect name, if found.
|
IDfEnumeration |
IDfLocalModuleRegistry.getAspectDescriptors()
Get a list of all Aspects available .
|
IDfId |
IDfSysObject.getAssembledFromId()
Returns the object id of the virtual document that was the source of the assembly associated with the object.
|
IDfSysObject |
IDfVirtualDocumentNode.getAssemblyDocument()
Returns the document with which an assembly is associated.
|
java.lang.String |
IDfVirtualDocumentNode.getAssemblyDocumentBinding()
Returns the binding value between the assembly's associated document and that
document's parent document.
|
IDfVirtualDocumentNode |
IDfVirtualDocumentNode.getAssemblyParent()
Returns an IDfVirtualDocumentNode object for the root of the assembly
that contains this node.
|
java.lang.String |
IDfFormat.getAssetClass() |
IDfWorkflowAttachment |
IDfWorkitem.getAttachment(IDfId attachmentId)
Returns an attachment object given the ID of the object.
|
IDfWorkflowAttachment |
IDfWorkflow.getAttachment(IDfId attachmentId)
Returns an attachment object given the ID of the object.
|
IDfCollection |
IDfWorkitem.getAttachments()
Returns a list of all the workflow's attachments.
|
IDfCollection |
IDfWorkflow.getAttachments()
Returns a list of all the workflow's attachments.
|
IDfAttr |
IDfTypedObject.getAttr(int attrIndex)
Returns an attribute description.
|
IDfList |
IDfPersistentObject.getAttrAssistance(java.lang.String attrName)
Deprecated.
use getValidator and then call getValueAssistance on IDfValidator instead
|
IDfList |
IDfPersistentObject.getAttrAssistanceWithValues(java.lang.String attrName,
IDfList depAttrNameList,
IDfList depAttrValueListList)
Deprecated.
use getValidator and then call getValueAssistance on IDfValidator instead
|
IDfList |
IDfPersistentObject.getAttrAsstDependencies(java.lang.String attrName)
Deprecated.
use getValidator and then call getValueAssistanceDependencies on IDfValidator instead
|
int |
IDfTypedObject.getAttrCount()
Returns the number of attributes belonging to this object.
|
int |
IDfTypedObject.getAttrDataType(java.lang.String attributeName)
Returns the data type of an attribute.
|
IDfList |
IDfAuditTrail.getAuditData()
This API gets the audit data information for this particular Audit Trail Object.
|
java.io.InputStream |
IDfAuditTrail.getAuditDataAsXMLStream()
This API gets an XML representation of an audit data information for this Audit Trail object.
|
IDfAuditTrailManager |
IDfSession.getAuditTrailManager()
Retrieves the Audit Trail manager for this session.
|
java.lang.String |
IDfSysObject.getAuthors(int index)
Returns the authors attribute at the specified index.
|
int |
IDfSysObject.getAuthorsCount()
Returns the number of values the authors attribute has.
|
java.lang.String |
IDfDocbaseMap.getAuthProtocol(int index)
Returns the authentication protocol of the repository at the specified index.
|
IDfId |
IDfWorkitem.getAutoMethodId()
Returns the object ID of the method that invokes the work item's application.
|
IDfVersionTreeLabels |
IDfVirtualDocumentNode.getAvailableVersions()
Returns a list of the version labels for the object represented by this node.
|
com.documentum.fc.common.IDfBasicAttributes |
IDfVirtualDocumentNode.getBasicAttributes() |
java.lang.String |
IDfVirtualDocumentNode.getBinding()
Returns the version label used to resolve the binding for this node.
|
IDfId |
IDfAssembly.getBookId()
Returns the object ID of the top-most containing virtual document.
|
boolean |
IDfTypedObject.getBoolean(java.lang.String attributeName)
Returns the boolean value of an attribute.
|
int |
IDfSysObject.getBranchCount()
Returns the number of branches on the version tree that contains the object.
|
java.lang.String |
IDfVersionPolicy.getBranchLabel()
Returns the next possible branched version label of an object.
|
int |
IDfContentCollection.getBufferSize() |
long |
IDfContentCollection.getBytePosition() |
java.io.ByteArrayInputStream |
IDfCollection.getBytesBuffer(java.lang.String cmd,
java.lang.String buf,
java.lang.String buflen,
int length)
Reserved for internal use.
|
IDfId |
IDfSysObject.getCabinetId()
Returns the object id of the cabinet that is the object's primary storage location.
|
IDfChangeDescription |
IDfVirtualDocument.getChangeDescription(int index)
Returns the change description at a given index position.
|
int |
IDfVirtualDocument.getChangeDescriptionCount()
Returns a count of the changes made in all open VDM windows.
|
java.lang.String |
IDfAspectRelation.getChild()
Returns the child aspect name of an aspect relation object.
|
IDfVirtualDocumentNode |
IDfVirtualDocumentNode.getChild(int index)
Returns a given child node of this node.
|
java.lang.String |
IDfForeignKey.getChildAttribute(int index)
Returns the child key property for the foreign key at the specified index.
|
int |
IDfForeignKey.getChildAttributesCount()
Returns the number child key properties for the foreign key.
|
int |
IDfVirtualDocumentNode.getChildCount()
Returns the number of immediate children for this node.
|
IDfId |
IDfRelation.getChildId()
Returns the object ID of the child object in the relationship.
|
java.lang.String |
IDfRelation.getChildLabel()
Returns the version label of the child object in the relationship.
|
IDfCollection |
IDfPersistentObject.getChildRelatives(java.lang.String relationTypeName)
Returns a collection of IDfRelation objects where parent is this object, and the relation_name matches
the value passed in as a parameter.
|
java.lang.String |
IDfRelationType.getChildType()
Returns the object type of a valid child object in the
relationship.
|
IDfId |
IDfVersionTreeLabels.getChronicleId()
Returns the object ID of the version tree's root version.
|
IDfId |
IDfSysObject.getChronicleId()
Returns the object id of the root object in the version tree.
|
IDfId |
IDfVirtualDocumentNode.getChronId()
Returns the chronicle ID for the object represented by this node.
|
int |
IDfUser.getClientCapability()
Returns the client capability as an integer.
|
IDfTypedObject |
IDfSession.getClientConfig()
Returns an api config object.
|
IDfTypedObject |
IDfClient.getClientConfig()
Returns information about DFC.
|
IDfTypedObject |
DfClient.getClientConfig() |
IDfEnumeration |
IDfClient.getClientNetworkLocations(java.lang.String clientIPAddress,
java.lang.String locale)
Deprecated.
use IDfAcsClient.getClientNetworkLocations()
|
IDfEnumeration |
DfClient.getClientNetworkLocations(java.lang.String clientIPAddress,
java.lang.String locale) |
IDfCollection |
IDfSysObject.getCollectionForContent(java.lang.String format,
int pageNumber)
Returns a collection containing the object's content in the repository.
|
IDfCollection |
IDfSysObject.getCollectionForContentEx2(java.lang.String format,
int pageNumber,
java.lang.String pageModifier)
Returns a collection containing the object's content in the repository.
|
IDfCollection |
IDfSysObject.getCollectionForContentEx3(java.lang.String format,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Returns a collection containing the object's content in the repository.
|
IDfContentCollection |
IDfSysObject.getCollectionForContentEx4(java.lang.String format,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Returns a collection containing the object's content in the repository.
|
java.lang.String |
IDfFormat.getCOMClassId()
Specifies the Microsoft COM Class ID for a format.
|
int |
IDfWorkflow.getCompleteWitem(int valueIndex)
Returns the number of completed work items for an activity.
|
IDfId |
IDfAssembly.getComponentChronicleId()
Returns the chronicle ID of the component document.
|
IDfId |
IDfPackage.getComponentChronId(int index)
Returns the component chronical id of one of the bound objects.
|
int |
IDfPackage.getComponentChronIdCount()
Returns the number of bound objects in this package.
|
IDfId |
IDfWorkflowAttachment.getComponentId()
Gets the component ID of the bound object.
|
IDfId |
IDfContainment.getComponentId()
Returns the chronicle ID of the component represented by the containment object.
|
IDfId |
IDfAssembly.getComponentId()
Returns the object ID of the component represented by the assembly object.
|
IDfId |
IDfSysObject.getComponentId(int index)
Returns the chronicle id of the component documents that make up the virtual document using the computed
attribute _componentID.
|
IDfId |
IDfPackage.getComponentId(int index)
Returns the component id of one of the bound objects.
|
int |
IDfSysObject.getComponentIdCount()
Returns the number of chronicle IDs of the component documents that make up the virtual document using the
computed attribute _componentID.
|
int |
IDfPackage.getComponentIdCount()
Returns the number of bound objects in this package.
|
java.lang.String |
IDfWorkflowAttachment.getComponentName()
Returns the component name, which is typically the object name
of the object identified in r_component_id.
|
java.lang.String |
IDfPackage.getComponentName(int index)
Returns the component name, which is typically the object name
of the object identified at the corresponding index position
in r_component_id
|
java.lang.String |
IDfWorkflowAttachment.getComponentType()
Gets the component type, which is the type name of the bound component.
|
java.lang.String |
IDfSysObject.getCompoundArchitecture()
Used by the virtual document manager to determine if the object can be changed.
|
int |
IDfActivity.getConditionCount()
Returns the number of routing conditions in the activity.
|
IDfId |
IDfActivity.getConditionId()
Returns the object ID of the repository object that stores
the route case conditions.
|
java.lang.String |
IDfActivity.getConditionName(int index)
Returns the name of a route case.
|
java.lang.String |
IDfActivity.getConditionPort(int index)
Returns the output ports associated with a specified route case.
|
IDfList |
IDfActivity.getConditions(java.lang.String routeCaseIdentifier)
Returns the list (or list of lists) of transition condition definitions for the named route case.
|
IDfTypedObject |
IDfSession.getConnectionConfig()
Returns the connection config object for a repository session.
|
java.lang.String |
IDfAssembly.getContainDescription() |
IDfId |
IDfSysObject.getContainId(int index)
Returns the object id of a containment object that link the component document to its containing virtual document
using the computed attribute _containID.
|
int |
IDfSysObject.getContainIdCount()
Returns the number of containment objects IDs that link the component document to its containing virtual document
using the computed attribute _containID.
|
java.lang.String |
IDfAssembly.getContainType() |
java.io.ByteArrayInputStream |
IDfSysObject.getContent()
Copies this object's content from the Documentum server into a
ByteArrayInputStream object. |
IDfContentAvailability |
IDfSysObject.getContentAvailability(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
java.lang.String networkLocationIdentifier)
Returns content availability settings.
|
java.io.ByteArrayInputStream |
IDfSysObject.getContentEx(java.lang.String format,
int pageNumber)
Copies this object's content in the repository into a
ByteArrayInputStream . |
java.io.ByteArrayInputStream |
IDfSysObject.getContentEx2(java.lang.String format,
int pageNumber,
java.lang.String pageModifier)
Copies this object's content in the repository into a
ByteArrayInputStream . |
java.io.ByteArrayInputStream |
IDfSysObject.getContentEx3(java.lang.String format,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Copies this object's content in the repository into a
ByteArrayInputStream . |
IDfCollection |
IDfFolder.getContents(java.lang.String attrNames)
Returns the values of specified attributes for all objects in a folder object.
|
IDfId |
IDfSysObject.getContentsId()
Returns the object id of the content object for an object that has only one content.
|
long |
IDfSysObject.getContentSize()
Returns the number of bytes in the content.
|
int |
IDfContentCollection.getContentSize()
Return the size of requested content.
|
long |
IDfSysObject.getContentSize(int page,
java.lang.String formatName,
java.lang.String pageModifier)
Return the content size according to the page, format and pageModifier of the content
|
int |
IDfSysObject.getContentState(int index)
Returns the state of the content for a given sysobject using the computed attribute
_content_state.
|
int |
IDfSysObject.getContentStateCount()
Returns the number of states of a content for the sysobject using the computed attribute _content_state.
|
java.lang.String |
IDfSysObject.getContentType()
Returns the file format of the object's content.
|
java.lang.String |
IDfQueueItem.getContentType()
Returns the file format of the object assciated with a router task.
|
IDfProperties |
IDfClient.getContext(java.lang.String contextId)
Returns the
IDfProperties object associated with a particular client. |
IDfProperties |
DfClient.getContext(java.lang.String contextId) |
int |
IDfActivity.getControlFlag()
Returns the control flag attribute of the activity.
|
java.lang.String |
IDfRelationType.getControllingKind()
Returns the controlling kind attribute defined for the relation of this type.
|
int |
IDfVirtualDocumentNode.getCopyBehavior()
Returns the copy behavior for the node.
|
int |
IDfRelationType.getCopyBehavior()
Returns the copy behavior defined for the relation of this type.
|
int |
IDfContainment.getCopyBehavior()
Returns the copy behavior defined for the component.
|
java.lang.String |
IDfWorkflow.getCorrelationIdentifier()
Returns value of the 'correlation_identifier' attribute.
|
IDfTime |
IDfWorkitem.getCreationDate()
Returns the date on which the work item was created.
|
IDfTime |
IDfWorkflowAttachment.getCreationDate()
Returns the r_creation_date attribute of the object.
|
IDfTime |
IDfSysObject.getCreationDate()
Returns the r_creation_date attribute of the object.
|
java.lang.String |
IDfWorkflowAttachment.getCreatorName()
Returns the name of the creator.
|
java.lang.String |
IDfWorkflow.getCreatorName()
Returns the name of the person who created the workflow.
|
java.lang.String |
IDfSysObject.getCreatorName()
Returns the name of the creator.
|
java.io.ByteArrayInputStream |
IDfContentCollection.getCurrentBuffer()
Returns the current content buffer.
|
int |
IDfContentCollection.getCurrentLength() |
int |
IDfDumpRecord.getCurrentObjectCount() |
java.lang.String |
IDfDumpRecord.getCurrentOffset() |
int |
IDfDumpRecord.getCurrentPos() |
int |
IDfDumpRecord.getCurrentRootCount() |
int |
IDfSysObject.getCurrentState()
Returns the current state.
|
java.lang.String |
IDfSysObject.getCurrentStateName()
Returns the name of the current state.
|
IDfTime |
IDfQueueItem.getDateSent()
Returns the date the work item, task, or event was sent.
|
java.lang.String |
IDfSession.getDBMSName()
Returns the name of the RDBMS that underlies the repository identified in the default repository scope.
|
int |
IDfSession.getDefaultACL()
Identifies the default ACL for a Documentum server.
|
java.util.Set<java.lang.String> |
IDfTypeInfo.getDefaultAspects()
Returns a set of name of the default aspects specified in this type and all of its supertypes.
|
int |
IDfVersionPolicy.getDefaultCheckinVersion()
Returns the default checkin version of an object.
|
java.lang.String |
IDfUser.getDefaultFolder()
Returns the default folder for a user.
|
IDfId |
IDfFormat.getDefaultStorage() |
IDfId |
IDfTypeInfo.getDefaultStorageId() |
int |
IDfProcess.getDefinitionState()
Returns the state of the workflow definition.
|
int |
IDfPolicy.getDefinitionState()
Return the attribute r_definition_state value.
|
java.lang.String |
IDfActivity.getDefinitionState()
Returns the state of the activity definition.
|
java.lang.String |
IDfQueueItem.getDependencyType()
Returns the dependency type.
|
int |
IDfAssembly.getDepth()
Returns the depth of this component within the top-most virtual document.
|
java.lang.String |
IDfQueueItem.getDequeuedBy()
Returns the name of the user who dequeued the item.
|
IDfTime |
IDfQueueItem.getDequeuedDate()
Returns the date on which the item was dequeued.
|
java.lang.String |
IDfUser.getDescription()
Returns the user-defined description for a user.
|
java.lang.String |
IDfType.getDescription()
Returns the user-defined label for a type.
|
java.lang.String |
IDfRelationType.getDescription()
Returns the user defined description of the relationship.
|
java.lang.String |
IDfRelation.getDescription()
Not system defined.Provided for user convenience.
|
java.lang.String |
IDfGroup.getDescription()
Returns the user-defined description of a group object.
|
java.lang.String |
IDfFormat.getDescription()
Retrieves the user-defined description of a format.
|
java.lang.String |
IDfACL.getDescription()
Returns the user-defined description of an ACL object.
|
java.lang.String |
IDfSysObject.getDirectDescendant()
Returns whether the object has any direct descendants (versions derived directly from this object).
|
java.lang.String |
IDfValueAssistance.getDisplayValue(java.lang.String actualValue)
Return the possible display value mapped to the specified actual value.
|
int |
IDfRetainer.getDispositionRule()
Returns the dm_retainer.disposition_rule value.
|
java.lang.String |
IDfSession.getDMCLSessionId()
Deprecated.
use
IDfSession.getSessionId() instead. |
IDfTypedObject |
IDfSession.getDocbaseConfig()
Returns a docbase config object for a repository session.
|
int |
IDfDocbaseMap.getDocbaseCount()
Returns the number of repositories known.
|
java.lang.String |
IDfDocbaseMap.getDocbaseDescription(int index)
Returns the administrator-defined description of the repository at the specified index.
|
java.lang.String |
IDfSession.getDocbaseId()
Returns the ID of the repository defined as the default repository scope.
|
java.lang.String |
IDfDocbaseMap.getDocbaseId(int index)
Returns the ID of the repository at the specified index.
|
IDfDocbaseMap |
IDfDocbrokerClient.getDocbaseMap()
Returns information about the repositories that are known to the set of connection brokers currently configured for this
IDfDocbrokerClient instance.
|
IDfDocbaseMap |
IDfClient.getDocbaseMap()
Returns information about the repositories that are known to a connection broker.
|
IDfDocbaseMap |
DfClient.getDocbaseMap() |
IDfDocbaseMap |
IDfClient.getDocbaseMapEx(java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the repositories that are known to a connection broker.
|
IDfDocbaseMap |
DfClient.getDocbaseMapEx(java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber) |
IDfDocbaseMap |
IDfDocbrokerClient.getDocbaseMapFromSpecificDocbroker(java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the repositories that are known to a specific connection broker.
|
java.lang.String |
IDfSession.getDocbaseName()
Returns the name of the repository identified as the default repository scope.
|
java.lang.String |
IDfDocbaseMap.getDocbaseName(int index)
Returns the name of the repository at the specified index.
|
java.lang.String |
IDfDocbrokerClient.getDocbaseNameFromDocbaseId(long docbaseId)
Returns the name of the repository from its numeric id.
|
java.lang.String |
IDfClient.getDocbaseNameFromDocbaseId(long docbaseId)
Returns the name of the repository with the specified numeric docbase id.
|
java.lang.String |
DfClient.getDocbaseNameFromDocbaseId(long docbaseId) |
java.lang.String |
IDfDocbrokerClient.getDocbaseNameFromId(IDfId objectId)
Returns the name of the repository from which the object and its
IDfId originated. |
java.lang.String |
IDfClient.getDocbaseNameFromId(IDfId objectId)
Returns the name of the repository from where the object and its
IDfId originated. |
java.lang.String |
DfClient.getDocbaseNameFromId(IDfId objectId) |
java.lang.String |
IDfSession.getDocbaseOwnerName()
Returns the name of the user who owns the repository identified as the default repository scope.
|
IDfList |
IDfDocbaseMap.getDocbaseRoles(int index) |
java.lang.String |
IDfSession.getDocbaseScope()
Returns the default repository scope of this session.
|
IDfTypedObject |
IDfSession.getDocbrokerMap()
Returns information about the DocBrokers known to the DFC.
|
IDfTypedObject |
IDfDocbrokerClient.getDocbrokerMap()
Returns information about the connection brokers known to this IDfDocbrokerClient instance.
|
IDfTypedObject |
IDfClient.getDocbrokerMap()
Returns information about the connection brokers known to the DFC.
|
IDfTypedObject |
DfClient.getDocbrokerMap() |
java.lang.String |
IDfACL.getDomain()
Returns the domain (owner name) of an ACL.
|
java.lang.String |
IDfDocbaseMap.getDormancyStatus(int index)
Returns the status of the docbase at the specified index
|
java.lang.String |
IDfFormat.getDOSExtension()
Retrieves the DOS extension used to copy files of this format into the common area, client local area, and
storage.
|
double |
IDfTypedObject.getDouble(java.lang.String attributeName)
Returns the double value of an attribute.
|
java.lang.Double |
IDfSysObject.getDoubleContentAttr(java.lang.String name,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Return a numeric content attribute.
|
IDfTime |
IDfWorkitem.getDueDate()
Returns the work item's due date.
|
IDfTime |
IDfQueueItem.getDueDate()
Returns the date on which the associated work item or task is expected to
be completed.
|
java.lang.String |
IDfDumpRecord.getDumpOperation() |
java.lang.String |
IDfDumpRecord.getDumpParameter(int index) |
java.lang.String |
IDfDumpRecord.getDumpType(int index) |
boolean |
IDfGroup.getDynamic()
Gets the dynamic setting of this group
|
boolean |
IDfGroup.getDynamicDefault()
Gets the default membership setting for the dynamic group.
|
java.lang.String |
IDfSession.getDynamicGroup(int index)
Gets the dynamic group at the specified index from the sessionConfig.
|
int |
IDfSession.getDynamicGroupCount()
Gets the number of dynamic groups that the session user is actively participating as a member of.
|
IDfTime |
IDfRelation.getEffectiveDate()
Not system defined.
|
IDfTime |
IDfLoadRecord.getEndTime() |
IDfTime |
IDfDumpRecord.getEndTime() |
int |
IDfRetainer.getEnforcementRule()
Returns the dm_retainer.enforcement_rule value.
|
java.lang.String |
IDfPolicy.getEntryCriteria(int index)
Get the entry criteria specified by the client for the server to generate
a dm_func_expr object and save its ID in the entry_criteria_id attribute
for the state with the given index.
|
IDfId |
IDfPolicy.getEntryCriteriaId(int index)
Return the attribute entry_criteria_id value at the specified index.
|
int |
IDfPolicy.getEntryCriteriaIdCount()
Return the number of attribute entry_criteria_id values for this policy.
|
java.lang.String |
IDfQueueItem.getEvent()
Returns the name of the event.
|
IDfEventManager |
IDfSession.getEventManager()
Retrieves the Event manager for this session.
|
IDfCollection |
IDfSession.getEvents()
Returns all unread items in a user's inbox.
|
java.lang.String |
IDfPolicy.getExceptionState(int index)
Return the attribute exception_state value at the specified index.
|
int |
IDfPolicy.getExceptionStateCount()
Return the number of attribute exception_state values for this policy.
|
java.lang.String |
IDfSysObject.getExceptionStateName()
Returns the name of the exception state associated
with the current state, if any exist.
|
int |
IDfActivity.getExecErrHandling()
Returns information about how the activity's runtime instance
handles execution failure.
|
IDfId |
IDfPackage.getExecMethodId()
Retrieves the method id of the corresponding workflow object.
|
IDfId |
IDfActivity.getExecMethodId()
Returns the object ID of the method object that executes the
activity's actions.
|
java.lang.String |
IDfWorkitem.getExecOsError()
Returns the error string, if any.
|
IDfId |
IDfWorkitem.getExecResultId()
Returns the object ID of the document containing the results
of the application's execution.
|
int |
IDfWorkitem.getExecRetriedCount()
Returns value of the r_exec_retried_count attribute.
|
int |
IDfActivity.getExecRetryInterval()
Returns the retry interval if the method execution fails for
the activity
For more information about activity execution, refer to
Server Fundamentals.
|
int |
IDfActivity.getExecRetryMax()
Returns the maximum retry number if the method execution fails for
the activity
For more information about activity execution, refer to
Server Fundamentals.
|
int |
IDfActivity.getExecSubtype()
Returns the exec_subtype attribute of the activity.
|
int |
IDfActivity.getExecTimeOut()
Returns the time-out period, in seconds, for the method that
executes the activity's actions.
|
int |
IDfActivity.getExecType()
Returns the execution type of the activity.
|
IDfTime |
IDfRelation.getExpirationDate()
Not system defined.
|
java.lang.String |
IDfWorkitem.getExtendedPerformer(int valueIndex)
Returns the name of an extended performer.
|
int |
IDfWorkitem.getExtendedPerformerCount()
Returns the number of extended performers for the work item.
|
IDfId |
IDfPolicy.getExtensionObjectId(int index)
Return the IDfId of the extension object for the state indicated by the index proviced.
|
java.lang.String |
IDfPolicy.getExtensionType()
Return the attribute extension_type value.
|
int |
IDfUser.getFailedAuthenticationAttempts()
Returns the number of failed attempts to authenticate the user.
|
java.lang.String |
IDfDocbaseMap.getFederationName(int index)
Returns the name of the federation for the repository at the specified index.
|
java.lang.String |
IDfSysObject.getFile(java.lang.String fileName)
Retrieves a content file from the Documentum server.
|
java.lang.String |
IDfSysObject.getFileEx(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
boolean other)
This is the extended method for retreiving a content file from the repository.
|
java.lang.String |
IDfSysObject.getFileEx2(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
boolean other)
This is the extended method for retreiving a content file from the repository.
|
java.lang.String |
IDfDumpRecord.getFileName() |
java.lang.String |
IDfFormat.getFilenameModifier() |
java.lang.String |
IDfMountPoint.getFileSystemPath()
Gets the file system path of this mount point.
|
java.lang.String |
IDfLocation.getFileSystemPath()
Gets the file system path of this location.
|
IDfFolder |
IDfSession.getFolderByPath(java.lang.String folderPath)
Returns a folder object.
|
IDfFolder |
IDfSession.getFolderBySpecification(java.lang.String folderSpec)
Returns the folder matching the folder specification or null if the folder can not be found.
|
IDfId |
IDfSysObject.getFolderId(int index)
Returns the object id of the folder linked to this object at the given index.
|
int |
IDfSysObject.getFolderIdCount()
Returns the number of folders linked to the object.
|
java.lang.String |
IDfFolder.getFolderPath(int index)
Returns a folder path to which a folder object is linked.
|
int |
IDfFolder.getFolderPathCount()
Returns the number of folder paths to which a folder object is linked.
|
boolean |
IDfVirtualDocumentNode.getFollowAssembly()
Returns the follow_assembly attribute setting for this node.
|
boolean |
IDfContainment.getFollowAssembly()
Indicates assembly behavior when the component has an associated assembly.
|
IDfFormat |
IDfSysObject.getFormat()
Returns the format of the object.
|
IDfFormat |
IDfSession.getFormat(java.lang.String formatName)
Returns a format object that contains information about the format.
|
java.lang.String |
IDfFormat.getFormatClass(int index) |
IDfList |
IDfWorkitem.getForwardActivities()
Returns a list of IDfActivity interfaces that have at least one input
port linked to one of the current activity's output ports.
|
int |
IDfSysObject.getFrozenAssemblyCount()
Returns a count of the number of frozen assemblies that contain the object.
|
IDfFtConfig |
IDfSession.getFtConfig()
Get the fulltext configuration object that contains information about what capabilities
the underlying fulltext engine has
|
long |
IDfContentCollection.getFullContentSize()
Return the size of requested content.
|
IDfDocbaseMap |
IDfAdminClient.getFullDocbaseMap()
Returns information about all repositories that are known to a connection broker.
|
IDfTypedObject |
IDfAdminClient.getFullDocbrokerMap()
Returns information about the connection brokers known to the DFC.
|
IDfTypedObject |
IDfAdminClient.getFullServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to a connection broker.
|
boolean |
IDfSysObject.getFullText()
Returns whether the document is marked for full-text indexing.
|
java.lang.String |
IDfDocbaseMap.getGoverningDocbase(int index)
Returns the name of the governing repository for the repository at the specified index.
|
IDfGroup |
IDfSession.getGroup(java.lang.String groupName)
Returns a group object that contains information about the repository group.
|
java.lang.String |
IDfGroup.getGroupAddress()
Returns the electronic mail address for a group object.
|
java.lang.String |
IDfGroup.getGroupAdmin()
Gets the admin of this group.
|
java.lang.String |
IDfGroup.getGroupClass()
Gets the class of this gruop.
|
int |
IDfUser.getGroupDefPermit()
Returns the default group permission assigned to objects created by a user.
|
IDfId |
IDfGroup.getGroupDirectoryId() |
java.lang.String |
IDfGroup.getGroupDisplayName()
Gets the display name of a group.
|
java.lang.String |
IDfGroup.getGroupGlobalUniqueId() |
java.lang.String |
IDfSysObject.getGroupName()
Returns the group name to which this object belongs.
|
java.lang.String |
IDfGroup.getGroupName()
Returns the name of a group object.
|
IDfId |
IDfGroup.getGroupNativeRoomId()
Gets the group native room id.
|
int |
IDfSysObject.getGroupPermit()
Returns the object-level permission assigned to the group for this object.
|
IDfCollection |
IDfGroup.getGroupsNames()
Returns a collection of group members' names in this group.
|
java.lang.String |
IDfGroup.getGroupsNames(int index)
Returns the name of a group that is a member in a group object at the specified index.
|
int |
IDfGroup.getGroupsNamesCount()
Returns the number of groups that are users in a group object.
|
java.lang.String |
IDfGroup.getGroupSource() |
java.lang.String |
IDfPlugin.getHardwarePlatform()
Gets the hardware platform of this plugin.
|
boolean |
IDfSysObject.getHasEvents()
Returns whether any users have registered to receive events for the object.
|
boolean |
IDfGroup.getHasEvents() |
boolean |
IDfSysObject.getHasFolder()
Returns whether this object is the CURRENT object in the version tree.
|
boolean |
IDfSysObject.getHasFrozenAssembly()
Returns whether the document's assembly is frozen.
|
java.lang.String |
IDfUser.getHomeDocbase()
Returns the user's home repository.
|
java.lang.String |
IDfMountPoint.getHostName()
Gets the host name of this mount point.
|
java.lang.String |
IDfDocbaseMap.getHostName()
Deprecated.
This internal attribute is not meaningful here
|
int |
IDfFormat.getIconIndex() |
IDfId |
IDfTypedObject.getId(java.lang.String attributeName)
Returns the ID value of an attribute.
|
IDfId |
IDfSession.getIdByQualification(java.lang.String qualification)
Returns the ID of a Documentum object that satisfies the DQL qualification.
|
int |
IDfRetainer.getImmutabilityRule()
Returns the dm_retainer.immutability_rule value.
|
java.lang.String |
IDfVersionLabels.getImplicitVersionLabel()
Returns the implicit version label associated with the SysObject.
|
java.lang.String |
IDfSysObject.getImplicitVersionLabel()
Returns the implicit version label from r_version_label.
|
boolean |
IDfVirtualDocument.getIncludeBrokenBindings()
Indicates whether nodes with broken bindings are included in the display.
|
java.lang.String |
IDfPolicy.getIncludedType(int index)
Return the attribute included_type value at the specified index.
|
int |
IDfPolicy.getIncludedTypeCount()
Return the number of attribute included_type values for this policy.
|
boolean |
IDfPolicy.getIncludeSubtypes(int index)
Return the attribute include_subtypes value at the specified index.
|
int |
IDfPolicy.getIncludeSubtypesCount()
Return the number of attribute include_subtypes values for this policy.
|
java.lang.String |
IDfWorkflow.getInitiateAct()
Returns value of the 'initiate_act' attribute.
|
int |
IDfQueueItem.getInstructionPage()
Returns the instruction page's page number.
|
java.lang.String |
IDfWorkflow.getInstructions(int index)
Returns the instructions attribute at the specified index.
|
int |
IDfWorkflow.getInstructionsCount()
Returns the number of values the instructions attribute has.
|
int |
IDfTypedObject.getInt(java.lang.String attributeName)
Returns the integer value of an attribute.
|
IDfId |
IDfQueueItem.getItemId()
Returns the object ID of the package or routed object.
|
java.lang.String |
IDfQueueItem.getItemName()
Returns the name of the package associated with the work item or
router task.
|
java.lang.String |
IDfQueueItem.getItemType()
Returns the object type of the package or routed object.
|
boolean |
IDfPolicy.getJavaMethods()
Return the attribute java_methods value.
|
java.lang.String |
IDfSysObject.getKeywords(int index)
Returns the keywords attribute at the specified index.
|
int |
IDfSysObject.getKeywordsCount()
Returns the number of keywords for the object.
|
IDfCollection |
IDfSession.getLastCollection()
Returns the collection object for the most recently executed query.
|
java.lang.String |
IDfWorkflow.getLastPerformer(int valueIndex)
Returns the name of the performer who most recently completed a work item for
a particular activity.
|
IDfId |
IDfWorkflow.getLastWitemId(int valueIndex)
Returns the object ID of the most recently completed work item for
a particular activity.
|
java.lang.String |
IDfVirtualDocumentNode.getLateBindingValue()
Returns the late binding value for the node.
|
boolean |
IDfSysObject.getLatestFlag()
Indicates whether this version is the most recent version of the object on a particular branch in the version
tree.
|
IDfTime |
IDfWorkitem.getLaunchTimeout()
Returns the launch timeout value of this work item.
|
com.documentum.fc.client.license.ILicenseManager |
IDfClient.getLicenseManager() |
com.documentum.fc.client.license.ILicenseManager |
DfClient.getLicenseManager() |
int |
IDfSysObject.getLinkCount()
Returns the number of objects linked to the object.
|
java.lang.String |
IDfProcess.getLinkDestActivity(int linkIndex)
Returns a link's destination activity.
|
java.lang.String |
IDfProcess.getLinkDestPort(int linkIndex)
Returns a link's destination port.
|
int |
IDfSysObject.getLinkHighCount()
Returns the current maximum order number assigned to a component.
|
java.lang.String |
IDfProcess.getLinkName(int linkIndex)
Returns a link name.
|
java.lang.String |
IDfProcess.getLinkSrcActivity(int linkIndex)
Returns a link's source activity.
|
java.lang.String |
IDfProcess.getLinkSrcPort(int linkIndex)
Returns a link's source port.
|
java.lang.String |
IDfLoadRecord.getLoadFileName() |
java.lang.String |
IDfLoadRecord.getLoadOperation() |
java.lang.String |
IDfLoadRecord.getLoadParameter(int index) |
java.lang.String |
IDfLoadRecord.getLoadType(int index) |
static IDfClient |
DfClient.getLocalClient()
Returns the
IDfClient interface for a singleton instance of DfClient. |
static IDfClient |
DfClient.getLocalClient32()
Deprecated.
Please use
DfClient.getLocalClient() instead |
IDfCollection |
IDfSysObject.getLocations(java.lang.String attrNames)
Runs a query to find all the places this object is used and returns the
query result as a collection.
|
IDfTime |
IDfSysObject.getLockDate()
Returns the date this object was locked.
|
java.lang.String |
IDfSysObject.getLockMachine()
Returns the name of the client machine on which the object was locked.
|
java.lang.String |
IDfSysObject.getLockOwner()
Returns the name of the user who locked the object.
|
java.lang.String |
IDfVersionPolicy.getLogComment()
Returns the log entry for an object.
|
java.lang.String |
IDfSysObject.getLogEntry()
Returns the comment specified by the user.
|
IDfLoginInfo |
IDfSession.getLoginInfo()
Returns a copy of the login information used to establish this DFC session.
|
java.lang.String |
IDfSession.getLoginTicket()
Returns a new ticket based on the current session login information.
|
java.lang.String |
IDfClient.getLoginTicketDiagnostics(java.lang.String loginTicket)
Return details extracted from a login ticket.
|
java.lang.String |
DfClient.getLoginTicketDiagnostics(java.lang.String loginTicket) |
java.lang.String |
IDfSession.getLoginTicketEx(java.lang.String userLoginName,
java.lang.String scope,
int timeout,
boolean singleUse,
java.lang.String serverName)
Returns a new ticket based on the current session login information.
|
java.lang.String |
IDfSession.getLoginTicketForUser(java.lang.String userName)
Returns a ticket for a specific user.
|
java.lang.String |
IDfSession.getLoginUserName()
Returns the repository name of the current user.
|
long |
IDfTypedObject.getLong(java.lang.String attributeName)
Returns the long integer value of an attribute.
|
java.lang.String |
IDfFormat.getMacCreator()
Retrieves the Macintosh creator to use for a format.
|
java.lang.String |
IDfMountPoint.getMacPreferredAlias()
Gets the Macintosh preferred alias of this mount point.
|
java.lang.String |
IDfFormat.getMacType()
Retrieves the Macintosh type to use for a format.
|
java.lang.String |
IDfSysObject.getMasterDocbase()
Returns the repository id of the repository that owns the object using the computed attribute _master_docbase.
|
java.lang.String |
IDfQueueItem.getMessage()
Returns the message associated with the work item, task, or event
notification.
|
java.lang.String |
IDfSession.getMessage(int severityLevel)
Returns all messages from an established session at or above a specified severity level.
|
java.lang.String |
IDfMethodObject.getMethodArgs(int index) |
java.lang.String |
IDfMethodObject.getMethodContent()
Gets the content of the method.
|
java.lang.String |
IDfMethodObject.getMethodType() |
java.lang.String |
IDfMethodObject.getMethodVerb() |
java.lang.String |
IDfFormat.getMIMEType()
Specifies the MIME (Multimedia Internet Mail Extension) type to use for a format.
|
IDfCollection |
IDfWorkitem.getMissingOutputPackages()
Returns a collection whose result objects describe all output
ports in the work item that don't have a package.
|
java.lang.String |
IDfSysObject.getModifier()
Returns the name of the user who made the last modification.
|
IDfTime |
IDfUser.getModifyDate()
Returns the time and date that a user was last modified.
|
IDfTime |
IDfSysObject.getModifyDate()
Returns the r_modify_date attribute of the object.
|
IDfTime |
IDfGroup.getModifyDate()
Returns the time and date that a group object was last modified.
|
java.lang.Class |
DfClient.getModuleClass(java.lang.String moduleName,
IDfSession session) |
IDfModuleDescriptor |
IDfLocalModuleRegistry.getModuleDescriptor(java.lang.String moduleName)
Gets the meta data for the service mapped to the service name, if found.
|
IDfEnumeration |
IDfLocalModuleRegistry.getModuleDescriptors()
Get a list of all modules available.
|
IDfLocalModuleRegistry |
IDfSession.getModuleRegistry()
Factory method that instantiates an
IDfLocalModulesRegistry , a repository module registry object. |
IDfGlobalModuleRegistry |
IDfClient.getModuleRegistry()
Factory method that instantiates an
IDfGlobalModuleRegistry global module registry object. |
IDfGlobalModuleRegistry |
DfClient.getModuleRegistry() |
java.lang.String |
IDfLocation.getMountPointName()
Gets the mount point name of this location.
|
java.lang.String |
IDfType.getName()
Returns a type's name.
|
java.lang.String |
IDfQueueItem.getName()
Returns the name of the queue owner.
|
java.lang.String |
IDfFormat.getName()
Retrieves the format name.
|
IDfNetworkLocationEntry |
IDfClient.getNetworkLocation(java.lang.String locationId,
java.lang.String locale)
Deprecated.
use IDfAcsClient.getNetworkLocation()
|
IDfNetworkLocationEntry |
DfClient.getNetworkLocation(java.lang.String locationId,
java.lang.String locale) |
IDfList |
IDfWorkitem.getNextActivityNames()
Retrieves all activities that immediately follow this work item.
|
java.lang.String |
IDfVersionPolicy.getNextMajorLabel()
Returns the next major implicit version label for an object.
|
java.lang.String |
IDfVersionPolicy.getNextMinorLabel()
Returns the next minor implicit version label for an object.
|
int |
IDfWorkflow.getNextSeqno()
Returns the next sequence number in the workflow.
|
java.lang.String |
IDfSysObject.getNextStateName()
Returns the name of the next state.
|
java.lang.String |
IDfQueueItem.getNextTasksType()
Indicates which tasks in the "next tasks list" are queued when
this task is forwarded.
|
IDfVirtualDocumentNode |
IDfVirtualDocument.getNodeFromNodeId(IDfId nodeId)
Returns the IDfVirtualDocumentNode interface for the node corresponding
to a given node ID.
|
java.lang.String |
IDfVDMNumberingScheme.getNodeNumber(IDfVirtualDocumentNode node)
Returns the hierarchy number of a virtual document component.
|
java.lang.String |
IDfVirtualDocumentNode.getNodeToken()
Returns a string representation of the virtual document node in a
particular format.The format corresponds to the virtual document
node's position with respect to the root.
|
int |
IDfPackage.getNoteCount()
Returns the number of notes in this package.
|
IDfTime |
IDfPackage.getNoteCreationDate(int noteIndex)
Returns an IDfTime interface which contains the creation date of the specified note.
|
int |
IDfPackage.getNoteFlag(int noteIndex)
Returns the special flags for a note.
|
IDfId |
IDfPackage.getNoteId(int noteIndex)
Returns the object id of the dm_note object.
|
boolean |
IDfPackage.getNotePersistance(int noteIndex)
Returns a boolean value to indicate whether the note is persistent across
all activities.
|
java.lang.String |
IDfPackage.getNoteText(int noteIndex)
Returns a String containing the content of the specified note.
|
java.lang.String |
IDfPackage.getNoteWriter(int noteIndex)
Returns the name of the user who wrote the note.
|
IDfVDMNumberingScheme |
IDfVirtualDocument.getNumberingScheme()
Returns the numbering scheme for the virtual document.
|
IDfPersistentObject |
IDfSession.getObject(IDfId objectId)
Returns a Documentum server object.
|
IDfPersistentObject |
IDfSession.getObjectByPath(java.lang.String objectPath)
Returns a Documentum server object given a full path to the object.
|
IDfPersistentObject |
IDfSession.getObjectByQualification(java.lang.String qualification)
Returns a Documentum server object that satisfies the DQL qualification.
|
IDfPersistentObject |
IDfSession.getObjectByQualificationWithInterface(java.lang.String qualification,
java.lang.String interfaceName)
Deprecated.
Please use Aspects instead for interface extension. They provide similar functionality but are safer and more robust.
|
java.lang.String |
IDfAliasSet.getObjectDescription()
Returns the description of the alias set.
|
IDfId |
IDfVersionLabels.getObjectId()
Returns the object ID of the SysObject.
|
IDfId |
IDfTypedObject.getObjectId()
Returns the ID of this object.
|
IDfId |
IDfVersionTreeLabels.getObjectIdFromVersionLabel(java.lang.String label)
Returns the object ID of the object carrying a given version label.
|
IDfPersistentObject |
IDfLightObject.getObjectImpl()
Retrieves an interface to the current object implementation.
|
java.lang.String |
IDfWorkflow.getObjectName()
Returns the name of the workflow object.
|
java.lang.String |
IDfSysObject.getObjectName()
Returns the object_name attribute of the object.
|
java.lang.String |
IDfAliasSet.getObjectName()
Returns the name of this alias set.
|
java.lang.String |
IDfACL.getObjectName()
Returns the ACL name.
|
IDfEnumeration |
IDfSession.getObjectPaths(IDfId objectId)
Generate
IDfEnumeration |
IDfObjectPathsMap |
IDfSession.getObjectPaths(IDfList objectIdsList)
Generate a map of
IDfObjectPath |
IDfEnumeration |
IDfSession.getObjectsByQuery(java.lang.String dql,
java.lang.String optionalTypeName)
Returns an enumeration of persistent objects using data obtained through a query.
|
IDfPersistentObject |
IDfSession.getObjectWithCaching(IDfId objectId,
java.lang.String typeNameIgnored,
java.lang.String classNameIgnored,
java.lang.String currencyCheckValue,
boolean usePersistentCache,
boolean useSharedCache)
Returns a Documentum server object.
|
IDfPersistentObject |
IDfSession.getObjectWithInterface(IDfId objectId,
java.lang.String extraInterfaceName)
Deprecated.
Please use Aspects instead for interface extension. They provide similar functionality but are safer and more robust.
|
IDfPersistentObject |
IDfSession.getObjectWithOptions(IDfId objectId,
IDfGetObjectOptions objectOptions)
Returns a Documentum server object.
|
IDfPersistentObject |
IDfSession.getObjectWithType(IDfId objectId,
java.lang.String typeNameIgnored,
java.lang.String classNameIgnored)
Deprecated.
|
java.lang.String |
IDfLoadRecord.getOffset() |
java.lang.String |
IDfPlugin.getOperatingSystem()
Gets the operating system of this plugin.
|
java.lang.String |
IDfQueueItem.getOperations()
Returns the value in the a_operations attribute of the queue item.
|
int |
IDfRelation.getOrderNumber()
Not system defined.
|
double |
IDfContainment.getOrderNumber()
Returns the position of the component among the components of the containing virtual document.
|
double |
IDfAssembly.getOrderNumber()
Returns the order number of the component within the top-most virtual document.
|
long |
IDfSysObject.getOtherFileSize(int page,
java.lang.String formatName,
java.lang.String pageModifier)
Return the other file (resource fork for mac os) size according to the page, format and pageModifier of the content
|
java.lang.String |
IDfWorkitem.getOutputPort(int valueIndex)
Returns the name of an output port of the work item.
|
int |
IDfWorkitem.getOutputPortCount()
Returns the number of output ports for the work item.
|
boolean |
IDfVirtualDocumentNode.getOverrideLateBindingValue()
Returns the use_node_ver_label attribute value from the containment object
associated with this node.
|
int |
IDfUser.getOwnerDefPermit()
Returns the default owner permission assigned to objects created by a user.
|
java.lang.String |
IDfSysObject.getOwnerName()
Returns the name of this object's owner.
|
java.lang.String |
IDfGroup.getOwnerName()
Returns the user name of the user who created a group object.
|
java.lang.String |
IDfAliasSet.getOwnerName()
Returns the user name of the owner of this alias set.
|
int |
IDfSysObject.getOwnerPermit()
Returns the object-level permission assigned to the owner of the object.
|
IDfPackage |
IDfWorkitem.getPackage(IDfId packageId)
Returns a package object given the ID of the object.
|
int |
IDfProcess.getPackageControl()
Returns the value of the package_control attribute.
|
int |
IDfPackage.getPackageCount()
Returns the package count of a collection package.
|
int |
IDfActivity.getPackageCount()
Returns the number of packages associated with the activity.
|
int |
IDfPackage.getPackageFlag()
Returns the package flag for the package (if it exists).
|
int |
IDfActivity.getPackageFlag(int index)
Returns the flag of a specified package.
|
IDfId |
IDfPackage.getPackageId(int index)
Rerturns the id of a package in a collection package.
|
IDfId |
IDfActivity.getPackageId(int index)
Returns the object ID of a specified package.
|
java.lang.String |
IDfPackage.getPackageLabel(int index)
Returns the version label for the package (if it exists).
|
java.lang.String |
IDfActivity.getPackageLabel(int index)
Returns the version label associated with the package.
|
java.lang.String |
IDfPackage.getPackageName()
Returns the package name.
|
java.lang.String |
IDfActivity.getPackageName(int index)
Returns the name of a specified package.
|
java.lang.String |
IDfPackage.getPackageOperation()
Returns the package operation, which is copied from the package definition upon
creation of a package.
|
java.lang.String |
IDfActivity.getPackageOperation(int index)
Returns information about the operation to be performed on
a specified package.
|
int |
IDfPackage.getPackageOrder()
Returns the order number, which identifies where a package definition appears in the
containing port definition.
|
int |
IDfActivity.getPackageReportFlag(int index)
Returns the report flag of a specified package.
|
IDfCollection |
IDfWorkitem.getPackages(java.lang.String additionalAttributes)
Returns a list of all the work item's packages.
|
IDfId |
IDfProcess.getPackageSchemaId(java.lang.String packageName)
Returns the object id of an XML schema if one exists.
|
java.lang.String |
IDfProcess.getPackageSchemaUri(java.lang.String packageName)
Returns the URL of an externally located schema if one exists.
|
int |
IDfWorkflow.getPackageSkillLevel(java.lang.String packageName)
Returns the skill level of the given package.
|
IDfCollection |
IDfActivity.getPackagesMetaData()
Returns a query result collection containing the following attributes:
r_package_name String
r_package_type Int
r_package_label String
r_package_flag Int
The collection is the metadata for the packages defined on an OUTPUT port;
If there is no output port, it returns meta data of packages defined on an INPUT port.
|
java.lang.String |
IDfPackage.getPackageType()
Returns the package type, which is the type name of the bound components.
|
java.lang.String |
IDfActivity.getPackageType(int index)
Returns the type of a specified package.
|
int |
IDfSysObject.getPageCount()
Returns the number of pages in the primary content.
|
java.lang.String |
IDfFormat.getPagePluginName()
Returns the name of the SBO (i.e. plugin) that implements the page aware functionality associated with
objects of this format.
|
IDfVirtualDocumentNode |
IDfVirtualDocumentNode.getParent()
Returns the IDfVirtualDocumentNode object for the immediate parent
of this node.
|
java.lang.String |
IDfAspectRelation.getParent()
Returns the parent aspect name of an aspect relation object.
|
java.lang.String |
IDfWorkflow.getParentActName()
Returns value of the 'parent_act_name' attribute.
|
int |
IDfWorkflow.getParentActSeqno()
Returns value of the 'parent_act_seqno' attribute.
|
java.lang.String |
IDfForeignKey.getParentAttribute(int index)
Returns the parent key property for the foreign key at the specified index.
|
int |
IDfForeignKey.getParentAttributesCount()
Returns the number of parent key properties for the foreign key.
|
IDfId |
IDfWorkflow.getParentId()
Returns value of the 'parent_id' attribute.
|
IDfId |
IDfRelation.getParentId()
Returns the object ID of the parent object.
|
IDfId |
IDfContainment.getParentId()
Returns the object ID of the containing virtual document.
|
IDfId |
IDfAssembly.getParentId()
Returns the object ID of the document that directly contains the virtual document described by the
assembly to which this assembly object belongs.
|
IDfCollection |
IDfPersistentObject.getParentRelatives(java.lang.String relationTypeName)
Returns a collection of IDfRelation objects where child is this object, and the relation_name matches
the value passed in as a parameter.
|
java.lang.String |
IDfRelationType.getParentType()
Returns the object type of a valid parent object in the
relationship.
|
int |
IDfPersistentObject.getPartition()
Returns i_partition for this object.
|
java.lang.String |
IDfSysObject.getPath(int pageNumber)
Retrieves the content location for an external store object.
|
java.lang.String |
IDfSysObject.getPathEx(int pageNumber,
java.lang.String pageModifier)
Retrieves the content location for an external store object.
|
java.lang.String |
IDfSysObject.getPathEx2(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Retrieves the content location for an external store object.
|
int |
IDfLocation.getPathType()
Gets the path type of this location.
|
int |
IDfActivity.getPerfCondIndex(java.lang.String condName)
Returns the index position of the corresponding condition in the expression object for the given performer condition.
|
IDfList |
IDfWorkflow.getPerformerActivityNames()
Returns a list of user and group names for the specified performer activity name.
|
IDfId |
IDfProcess.getPerformerAliasId()
Returns process's performer alias set object id.
|
java.lang.String |
IDfActivity.getPerformerCondition(java.lang.String condtionName)
For the given condition name, return the corresponding performer condition.
|
int |
IDfActivity.getPerformerConditionCount()
Returns the number of performer conditions in the activity.
|
IDfId |
IDfActivity.getPerformerConditionId()
Returns the object ID of the repository object that stores
the performer conditions.
|
java.lang.String |
IDfActivity.getPerformerConditionName(int index)
Returns the name of a performer condition.
|
IDfList |
IDfActivity.getPerformerConditionNames()
Return a String list that contains the name of the performer conditions.
|
java.lang.String |
IDfActivity.getPerformerConditionUser(int index)
Returns the user associated with a specified performer condition.
|
int |
IDfActivity.getPerformerFlag()
Indicates whether the activity's performer can delegate or extend
the activity.
|
int |
IDfWorkflow.getPerformerFlag(int valueIndex)
Indicates the activity performer's extra capabilities.
|
java.lang.String |
IDfWorkitem.getPerformerName()
Returns the name of the work item's performer.
|
java.lang.String |
IDfActivity.getPerformerName()
Returns the name of the user or group intended to perform the activity.
|
int |
IDfActivity.getPerformerNameCount()
Returns the number of values the performer name attribute has.
|
IDfList |
IDfWorkflow.getPerformers(java.lang.String actName)
Returns a list of user and group names for the specified performer activity name.
|
IDfList |
IDfActivity.getPerformers(java.lang.String conditionName)
For the given condition name, return a String list of performers used for this condition.
|
int |
IDfActivity.getPerformerType()
Returns the kind of user who can perform the activity.
|
boolean |
IDfRelationType.getPermanentLink()
Indicates if you want to maintain the relationship across versions of
the parent object.
|
boolean |
IDfRelation.getPermanentLink()
Deprecated.
As of DFC 5.3, replaced by IDfRelationType.getPermanentLink()
|
IDfList |
IDfSysObject.getPermissions()
Returns a list of
DfPermit objects representing all the permissions specified in the ACL for the
sysobject. |
IDfList |
IDfACL.getPermissions()
Returns a list of
DfPermit objects representing all the permissions specified in the ACL. |
int |
IDfSysObject.getPermit()
Returns an integer number that corresponds to the access permission level that the current user has for the
object.
|
int |
IDfACL.getPermit(java.lang.String accessorName)
Returns the basic permission level assigned to a user or group.
|
int |
IDfSysObject.getPermitEx(java.lang.String accessorName)
Returns an integer number that corresponds to the access permission level that the specified user or group has
for the object.
|
IDfTime |
IDfQueueItem.getPlanStartDate()
Returns the expected starting date of the associated router task.
|
java.lang.String |
IDfPlugin.getPluginType()
Gets the type of this plugin.
|
IDfId |
IDfSysObject.getPolicyId()
Returns the object id of attached business policy object.
|
java.lang.String |
IDfSysObject.getPolicyName()
Returns the name of attached business policy object.
|
int |
IDfActivity.getPortCount()
Returns the number of ports in the activity.
|
java.lang.String |
IDfPackage.getPortName()
Returns the name of the port of the activity runtime instance in which the
package is being handled.
|
java.lang.String |
IDfActivity.getPortName(int index)
Returns the name of a specified port.
|
java.lang.String |
IDfActivity.getPortType(int index)
Returns the type of a specified port.
|
double |
IDfQueueItem.getPosition()
Returns the value in the position attribute.
|
int |
IDfLoadRecord.getPosition() |
int |
IDfActivity.getPostTimer()
Returns the post-timer value defined for the activity.
|
IDfTime |
IDfWorkflow.getPostTimer(int valueIndex)
Returns the post-timer value for an activity.
|
IDfId |
IDfActivity.getPostTimerAction(int index)
Returns the ID of a timer action object at the given index within a timer series.
|
int |
IDfActivity.getPostTimerCount()
Returns the number of timer actions within the series.
|
int |
IDfActivity.getPostTimerIncrement(int index)
Returns the interval in minutes that must pass before the timer is fired.
|
java.lang.String |
IDfLoadRecord.getPredicate(int index) |
java.lang.String |
IDfDumpRecord.getPredicate(int index) |
java.lang.String |
IDfDumpRecord.getPredicate2(int index) |
int |
IDfActivity.getPreTimer()
Returns the pre-timer value for the activity.
|
IDfTime |
IDfWorkflow.getPreTimer(int valueIndex)
Returns the pre-timer value for an activity.
|
IDfId |
IDfActivity.getPreTimerAction(int index)
Returns the ID of a timer action object at the given index within a timer series.
|
int |
IDfActivity.getPreTimerCount()
Returns the number of timer actions within the series.
|
int |
IDfActivity.getPreTimerIncrement(int index)
Returns the interval in minutes that must pass before the timer is fired.
|
IDfList |
IDfWorkitem.getPreviousActivityNames()
Retrieves all activities that immediately preceeded this work item.
|
java.lang.String |
IDfSysObject.getPreviousStateName()
Returns the name of the previous state.
|
int |
IDfWorkitem.getPriority()
Returns the priority assigned to the work item.
|
int |
IDfQueueItem.getPriority()
Returns the priority of the associated work item or task.
|
IDfProcess |
IDfWorkflowBuilder.getProcess()
Returns the process object on which the workflow is based.
|
IDfId |
IDfWorkflow.getProcessId()
Returns the object ID of the workflow's definition.
|
int |
IDfProcess.getProcessLinkCount()
Returns the number of links in the workflow definition.
|
IDfProperties |
IDfVirtualDocumentNode.getProperties()
Returns an interface to the DfProperties object owned by this virtual document node.
|
IDfId |
IDfWorkitem.getQueueItemId()
Returns the object ID of the queue item corresponding to the work item.
|
int |
IDfSysObject.getReferenceCount()
Returns the number of folder references made by the object.
|
IDfList |
IDfAuditTrailManager.getRegisteredEvents(IDfId objectId)
Gets a list of registered events(String) for the object.
|
IDfList |
IDfAuditTrailManager.getRegisteredEventsForType(java.lang.String typeName,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName)
Gets a list of registered events(String) for the object type.
|
IDfList |
IDfWorkitem.getRejectActivities()
Returns a list of activity objects that have at least one
revert port.
|
IDfSession |
IDfSession.getRelatedSession(IDfId objectId)
Returns a related session appropriate for operating on the given object id.
|
IDfSession |
IDfSession.getRelatedSession(java.lang.String docbaseSpecString)
Returns a related session to a named docbase.
|
int |
IDfAspectRelation.getRelation()
Returns the aspect relation type of an aspect relation object.
|
java.lang.String |
IDfRelationType.getRelationName()
Returns the value of the relation_name attribute.
|
java.lang.String |
IDfRelation.getRelationName()
Returns the attribute value of relation_name.
|
IDfId |
IDfVirtualDocumentNode.getRelationshipId()
Returns the object ID of the containment or assembly object for this node.
|
IDfRelationType |
IDfSession.getRelationType(java.lang.String relationName)
Returns a relation type object that contains information about a kind of relationship.
|
IDfId |
IDfSysObject.getRemoteId()
Returns the object id of the remote object.
|
int |
IDfRetainer.getRenditionRule()
Returns the dm_retainer.rendition_rule value.
|
IDfCollection |
IDfSysObject.getRenditions(java.lang.String attrNames)
Runs a query against the dmr_content table to return values for all the page 0
content for this object.
|
boolean |
IDfTypedObject.getRepeatingBoolean(java.lang.String attributeName,
int valueIndex)
Returns a boolean value stored in a repeating attribute.
|
double |
IDfTypedObject.getRepeatingDouble(java.lang.String attributeName,
int valueIndex)
Returns a double value stored in a repeating attribute.
|
IDfId |
IDfTypedObject.getRepeatingId(java.lang.String attributeName,
int valueIndex)
Returns an Object ID value stored in a repeating attribute.
|
int |
IDfTypedObject.getRepeatingInt(java.lang.String attributeName,
int valueIndex)
Returns an integer value stored in a repeating attribute.
|
long |
IDfTypedObject.getRepeatingLong(java.lang.String attributeName,
int valueIndex)
Returns a long integer value stored in a repeating attribute.
|
java.lang.String |
IDfActivity.getRepeatingPerformerName(int index)
Returns the performer name attribute at the specified index.
|
java.lang.String |
IDfTypedObject.getRepeatingString(java.lang.String attributeName,
int valueIndex)
Returns a string value stored in a repeating attribute.
|
IDfTime |
IDfTypedObject.getRepeatingTime(java.lang.String attributeName,
int valueIndex)
Returns a date/time value stored in a repeating attribute.
|
IDfValue |
IDfTypedObject.getRepeatingValue(java.lang.String attributeName,
int valueIndex)
Returns a value stored in a repeating attribute as an IDfValue object.
|
boolean |
IDfWorkflow.getRepeatInvoke(int valueIndex)
Indicates whether the activity is repeatable.
|
IDfPersistentObject |
IDfSession.getReplicaForMaster(IDfId masterId)
Get the replica object for a specific master object.
|
java.lang.String |
IDfSysObject.getResolutionLabel()
Returns the default version label used to resolve late-bound nodes of a virtual document.
|
java.lang.String |
IDfActivity.getResolvePackageName()
Returns the package name used to resolve performer aliasing.
|
int |
IDfActivity.getResolveType()
Returns the performer aliasing resolve type of the activity.
|
int |
IDfSysObject.getResumeState()
Returns the resume state.
|
java.lang.String |
IDfSysObject.getResumeStateName()
Returns the resume state name.
|
int |
IDfSysObjectRetention.getRetainerCount()
Returns the number of entries in the i_retainer_id field.
|
int |
IDfSysObject.getRetainerCount()
Return the number of retainers on this object.
|
IDfId |
IDfSysObjectRetention.getRetainerId(int index)
Returns an entry from the i_retainer_id field.
|
IDfId |
IDfSysObject.getRetainerId(int index)
Return the id of the requested retainer.
|
IDfId |
IDfRetainer.getRetainerRootId()
Returns the dm_retainer.retainer_root_id value.
|
int |
IDfRetainer.getRetainerStrategy()
Returns the dm_retainer.retainer_strategy value.
|
IDfTime |
IDfSysObject.getRetainUntilDate()
Returns the retain until date for this object.
|
IDfTime |
IDfSysObject.getRetentionDate()
Used internally.
|
IDfTime |
IDfRetainer.getRetentionDate()
Returns the dm_retainer.retention_date value.
|
int |
IDfRetainer.getRetentionInterval()
Returns the dm_retainer.retention_interval value.
|
int |
IDfRetainer.getRetentionRuleType()
Returns the dm_retainer.retention_rule_type value.
|
int |
IDfRetainer.getRetentionStatus()
Returns the dm_retainer.r_retention_status value.
|
java.lang.String |
IDfRetainer.getRetentionStorageClass()
Returns the dm_retainer.retention_storage_class value.
|
int |
IDfPolicy.getReturnCondition(int index)
Return the attribute return_condition value at the specified index.
|
int |
IDfPolicy.getReturnConditionCount()
Return the number of attribute return_condition values for this policy.
|
boolean |
IDfPolicy.getReturnToBase(int index)
Return the attribute return_to_base value at the specified index.
|
int |
IDfPolicy.getReturnToBaseCount()
Return the number of attribute return_to_base values for this policy.
|
int |
IDfWorkitem.getReturnValue()
Returns the return value.
|
int |
IDfDumpRecord.getRootCount() |
IDfVirtualDocumentNode |
IDfVirtualDocument.getRootNode()
Returns the node that is the root of the virtual document.
|
java.lang.String |
IDfActivity.getRouteCaseCondition(java.lang.String RouteCaseIdentifier)
Returns the route case condition of the given route case identifier.
|
IDfList |
IDfActivity.getRouteCaseIdentifiers()
Returns a String list that contains the name of the route case identifiers.
|
IDfList |
IDfActivity.getRouteCasePorts(java.lang.String RouteCaseIdentifier)
Returns a String list that contains the output ports of the given route case identifier.
|
IDfId |
IDfQueueItem.getRouterId()
Returns the object ID of the associated workflow or router.
|
IDfCollection |
IDfSysObject.getRouters(java.lang.String additionalAttributes,
java.lang.String orderBy)
Returns a collection of routers the document participates in.
|
IDfCollection |
IDfSession.getRunnableProcesses(java.lang.String additionalAttributes)
Returns a collection that contains the object ID and attribute values of all installed dm_process objects in a
repository.
|
int |
IDfWorkitem.getRuntimeState()
Returns the work item's state.
|
int |
IDfWorkflow.getRuntimeState()
Returns the state of the workflow.
|
java.lang.String |
IDfVersionPolicy.getSameLabel()
Returns the current implicit version label of an object.
|
java.lang.String |
IDfSession.getSecurityMode()
Returns the security mode of the repository identified as the default repository scope.
|
java.lang.String |
IDfRelationType.getSecurityType()
Returns the security applied to objects of type dm_relation_type
whose relation_name attribute value matches the
relation_name attribute for the dm_relation_type object.
|
int |
IDfMountPoint.getSecurityType()
Gets the security type of this mount point.
|
int |
IDfLocation.getSecurityType()
Gets the security type of this location.
|
IDfSysObject |
IDfVirtualDocumentNode.getSelectedObject()
Returns an IDfSysObject interface for the document represented by the node.
|
java.lang.String |
IDfQueueItem.getSentBy()
Returns the name of the user who sent the work item, task,
or event notification.
|
IDfTypedObject |
IDfSession.getServerConfig()
Returns a server config object for a repository session.
|
IDfTypedObject |
IDfDocbaseMap.getServerMap(int index)
Returns information about Documentum servers for the repository at the specified index.
|
IDfTypedObject |
IDfSession.getServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to a DocBroker.
|
IDfTypedObject |
IDfDocbrokerClient.getServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to the set of connection brokers currently configured for this
IDfDocbrokerClient instance.
|
IDfTypedObject |
IDfClient.getServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to a connection broker.
|
IDfTypedObject |
DfClient.getServerMap(java.lang.String docbaseName) |
IDfTypedObject |
IDfDocbaseMap.getServerMapByName(java.lang.String docbaseName)
Returns information about Documentum servers for the repository with the specified name.
|
IDfTypedObject |
IDfClient.getServerMapEx(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the servers known to a connection broker.
|
IDfTypedObject |
DfClient.getServerMapEx(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber) |
IDfTypedObject |
IDfDocbrokerClient.getServerMapFromSpecificDocbroker(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the servers that are known to a specific connection broker.
|
java.lang.String |
IDfSession.getServerVersion()
Returns the version string of a Documentum server.
|
java.lang.String |
IDfDocbaseMap.getServerVersion(int index)
Returns the version string of the Documentum server at the specified index.
|
IDfModuleDescriptor |
IDfGlobalModuleRegistry.getServiceDescriptor(java.lang.String serviceName)
Gets the meta data for the service mapped to the service name, if found.
|
IDfEnumeration |
IDfGlobalModuleRegistry.getServiceDescriptors()
Get a list of all services (SBO) available.
|
IDfTypedObject |
IDfSession.getSessionConfig()
Returns the session config object for a repository session.
|
java.lang.String |
IDfSession.getSessionId()
Returns the DFC session ID of the session.
|
IDfSession |
IDfClient.getSharedSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo,
java.lang.String key)
Deprecated.
use
IDfSessionManager instead for session sharing |
IDfSession |
DfClient.getSharedSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo,
java.lang.String key) |
IDfId |
IDfLightObject.getSharingParent()
Retrieves the ID of the lightobject's parent.
|
java.lang.String |
IDfAuditTrail.getSignData()
This API gets the signData information for this particular Audit Trail object.
|
IDfTime |
IDfQueueItem.getSignOffDate()
Returns the date on which the work item or task was signed off.
|
boolean |
IDfActivity.getSignoffRequired()
Indicates whether the activity requires a sign off.
|
java.lang.String |
IDfQueueItem.getSignOffUser()
Returns the name of the user who signed off the item.
|
int |
IDfWorkitem.getSkillLevel()
Returns the skill level of the task.
|
java.lang.String |
IDfQueueItem.getSourceDocbase()
Returns the repository that is the source of the queued object.
|
IDfId |
IDfQueueItem.getSourceEvent()
Returns the object ID of the queued item in the source repository.
|
int |
IDfQueueItem.getSourceStamp()
Returns the vstamp value of the source queue item.
|
java.lang.String |
IDfSysObject.getSpecialApp()
Reserved for use by Documentum products.
|
IDfId |
IDfQueueItem.getStamp()
Returns the object ID of the queue item object.
|
IDfList |
IDfProcess.getStartActivities(java.lang.String initiateAct)
Return the list of start activities linked with the given initiate activity.
|
IDfList |
IDfWorkflowBuilder.getStartActivityIds()
Returns the object IDs of the start activities in the workflow's definition.
|
IDfList |
IDfWorkflowBuilder.getStartActivityNames()
Returns the names of the start activities in the workflow's definition.
|
IDfTime |
IDfWorkflow.getStartDate()
Returns the start date of the workflow.
|
int |
IDfWorkflowBuilder.getStartStatus()
Indicates whether the user can start the workflow.
|
IDfTime |
IDfLoadRecord.getStartTime() |
IDfTime |
IDfDumpRecord.getStartTime() |
int |
IDfPolicy.getStateClass(int index)
Return the attribute state_class value at the specified index.
|
int |
IDfPolicy.getStateClassCount()
Return the number of attribute state_class values for this policy.
|
java.lang.String |
IDfPolicy.getStateDescription(int index)
Return the attribute state_description value at the specified index.
|
int |
IDfPolicy.getStateDescriptionCount()
Return the number of attribute state_description values for this policy.
|
IDfStateExtension |
IDfPolicy.getStateExtension(int stateNo)
Return the IDfStateExtension for the specified state or null if one does
not exist.
|
int |
IDfPolicy.getStateIndex(java.lang.String stateName)
Return the index of the attribute state_name value.
|
java.lang.String |
IDfPolicy.getStateName(int index)
Return the attribute state_name value at the specified index.
|
int |
IDfPolicy.getStateNameCount()
Return the number of state_name values for this policy.
|
int |
IDfStateExtension.getStateNo()
Returns the number of the state that this object extends.
|
int |
IDfPolicy.getStateNo(int index)
Return the attribute i_state_no value at the specified index.
|
int |
IDfPolicy.getStateNoCount()
Return the number of attribute i_state_no values for this policy.
|
java.lang.String |
IDfPolicy.getStateType(int index)
Return the attribute state_type value at the specified index.
|
int |
IDfPolicy.getStateTypeCount()
Return the number of attribute state_type values for this policy.
|
java.lang.String |
IDfSysObject.getStatus()
Returns the a_status attribute of the object.
|
java.lang.String |
IDfSysObject.getStorageType()
Returns the default storage area for content files associated with the object.
|
java.io.InputStream |
IDfSysObjectStream.getStream(java.lang.String format,
int page,
java.lang.String pageModifier,
boolean other)
Retrieves a content as InputStream from the Documentum server.
|
java.lang.String |
IDfTypedObject.getString(java.lang.String attributeName)
Returns the string value of an attribute.
|
java.lang.String |
IDfSysObject.getStringContentAttr(java.lang.String name,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Return a string content attribute.
|
java.lang.String |
IDfSysObject.getSubject()
Returns the subject attribute of the object.
|
int |
IDfMethodObject.getSuccessReturnCodes(int index) |
java.lang.String |
IDfMethodObject.getSuccessStatus() |
java.lang.String |
IDfGroup.getSupergroupsNames(int index) |
int |
IDfGroup.getSupergroupsNamesCount() |
java.lang.String |
IDfType.getSuperName()
Returns the name of a type's supertype.
|
IDfType |
IDfType.getSuperType()
Returns a type's super type.
|
java.lang.String |
IDfWorkflow.getSupervisorName()
Returns the name of the workflow's supervisor.
|
java.lang.String |
IDfQueueItem.getSupervisorName()
Returns the name of the workflow or router supervisor.
|
IDfId |
IDfPolicy.getSystemActions(int index)
Return the attribute system_actions value at the specified index.
|
int |
IDfPolicy.getSystemActionsCount()
Return the number of attribute system_actions values for this policy.
|
java.lang.String |
IDfQueueItem.getTargetDocbase()
Returns the name of the target repository.
|
IDfId |
IDfWorkitem.getTargetTaskId()
Returns value of the r_target_task_id attribute
|
java.lang.String |
IDfQueueItem.getTaskName()
Returns the value in the task_name attribute.
|
java.lang.String |
IDfQueueItem.getTaskNumber()
Returns the activity's sequence number if this is work item or the
task number if this is a router task.
|
IDfCollection |
IDfSession.getTasks(java.lang.String userName,
int filter,
java.lang.String additionalAttributes,
java.lang.String orderBy)
Retrieves the work items assigned to the specified user.
|
IDfCollection |
IDfSession.getTasksEx(java.lang.String userName,
int filter,
IDfList orderByList,
IDfList ascendingList)
Retrieves the work items assigned to the specified user.
|
java.lang.String |
IDfQueueItem.getTaskState()
Returns the state of the associated work item or router task.
|
java.lang.String |
IDfQueueItem.getTaskSubject()
Returns a subject for the task inbox item
|
java.lang.String |
IDfActivity.getTaskSubject()
Returns a subject for the task inbox item, the subject will be constructed at
the creation time of the inbox item
|
java.lang.String |
IDfQueueItem.getTaskType()
Returns the type of the activity or task associated with the queued item.
|
IDfModuleDescriptor |
IDfLocalModuleRegistry.getTboDescriptor(java.lang.String typeName)
Gets the meta data for the Type Based Business Objects mapped to the type name, if found.
|
IDfEnumeration |
IDfLocalModuleRegistry.getTboDescriptors()
Get a list of all Type Based Business Objects (TBO) available.
|
IDfTime |
IDfTypedObject.getTime(java.lang.String attributeName)
Returns the date/time value of an attribute.
|
IDfTime |
IDfSysObject.getTimeContentAttr(java.lang.String name,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Return a time content attribute.
|
int |
IDfMethodObject.getTimeoutDefault() |
int |
IDfMethodObject.getTimeoutMax() |
int |
IDfMethodObject.getTimeoutMin() |
java.lang.String |
IDfSysObject.getTitle()
Returns the title attribute of the object.
|
java.lang.String |
IDfFormat.getTopicFilter()
Retrieves the indexing filter to be used when indexing a file that has a directly indexable format.
|
IDfId |
IDfFormat.getTopicFormat()
Retrieves the object ID of the format to which this format must be transformed to allow indexing.
|
java.lang.String |
IDfFormat.getTopicFormatName()
Retrieves the name of the format to which this format must be transformed to allow indexing.
|
boolean |
IDfFormat.getTopicTransform()
Indicates if it is necessary to transform a format before indexing is allowed.
|
int |
IDfWorkflow.getTotalWitem(int valueIndex)
Returns the number of work items generated by an activity.
|
int |
IDfActivity.getTransitionEvalCount()
Returns the number of completed tasks that are required to trigger
the next activities.
|
int |
IDfActivity.getTransitionFlag()
Returns when and how to trigger the selected outgoing paths
when activity is manual transition
|
int |
IDfActivity.getTransitionMaxOutputCount()
Returns the maximum number of output ports user can select at runtime
when activity is manual transition
|
int |
IDfActivity.getTransitionType()
Returns the type of transition defined for the activity.
|
java.lang.String |
IDfActivity.getTriggerEvent()
Returns the expected event type that can trigger the activity.
|
int |
IDfWorkflow.getTriggerInput(int valueIndex)
Returns the number of triggered input ports.
|
int |
IDfWorkflow.getTriggerRevert(int valueIndex)
Returns a value indicating whether a revert port was triggered for an
activity instance.
|
int |
IDfWorkflow.getTriggerThresh(int valueIndex)
Returns the trigger threshold for an activity.
|
int |
IDfActivity.getTriggerThreshold()
Returns the number of input ports in the activity that must be
triggered to start the activity.
|
IDfType |
IDfPersistentObject.getType()
Provides an IDfType interface representing the type of this object.
|
IDfType |
IDfSession.getType(java.lang.String typeName)
Returns a Documentum server type object.
|
IDfAttr |
IDfType.getTypeAttr(int attrIndex)
Returns an IDfAttr representing the type's attribute located at the position
attrIndex in
this object's list of attributes. |
IDfList |
IDfType.getTypeAttrAssistanceWithValues(java.lang.String attrName,
IDfId policyId,
java.lang.String state,
IDfList depAttrNameList,
IDfList depAttrValueListList)
Deprecated.
|
IDfList |
IDfType.getTypeAttrAsstDependencies(java.lang.String attrName,
IDfId policyId,
java.lang.String state)
Deprecated.
|
int |
IDfType.getTypeAttrCount()
Returns the number of attributes in a type.
|
int |
IDfType.getTypeAttrDataType(java.lang.String attrName)
Returns the datatype of an attribute.
|
int |
IDfType.getTypeAttrDataTypeAt(int index)
Returns the datatype of an attribute.
|
java.lang.String |
IDfType.getTypeAttrDescription(java.lang.String attrName)
Returns the user-defined label for an attribute.
|
java.lang.String |
IDfType.getTypeAttrDescriptionAt(int index)
Returns the user-defined label for an attribute.
|
int |
IDfType.getTypeAttrLength(java.lang.String attrName)
Returns the maximum number of characters in a string-valued attribute.
|
int |
IDfType.getTypeAttrLengthAt(int index)
Returns the maximum number of characters in a string-valued attribute.
|
java.lang.String |
IDfType.getTypeAttrNameAt(int index)
Returns an attribute name for a type.
|
IDfTypedObject |
IDfSession.getTypeDescription(java.lang.String typeName,
java.lang.String attribute,
IDfId policyId,
java.lang.String state)
Returns the data dictionary information about an object type and its attributes.
|
IDfTypedObject |
IDfCollection.getTypedObject()
Returns a row in the collection as an
IDfTypedObject for later use. |
java.lang.String |
IDfSysObject.getTypeName()
Returns the r_object_type attribute of the object.
|
IDfId |
IDfPolicy.getTypeOverrideId(int index)
Return the attribute type_override_id value at the specified index.
|
int |
IDfPolicy.getTypeOverrideIdCount()
Return the number of attribute type_override_id values for this policy.
|
IDfValidator |
IDfType.getTypeValidator(IDfId policyId,
java.lang.String state)
Returns the IDfValidator that is assocated with this IDfType.
|
java.lang.String |
IDfType.getTypeWidgetType(int environment,
java.lang.String attrName,
IDfId policyId,
java.lang.String state)
Deprecated.
|
IDfId |
IDfVirtualDocument.getUniqueObjectId(int index)
Returns the object ID of the object at the specified index.
|
int |
IDfVirtualDocument.getUniqueObjectIdCount()
Returns the count of the unique object IDs in the current virtual document.
|
java.lang.String |
IDfMountPoint.getUnixPreferredAlias()
Gets the UNIX preferred alias of this mount point.
|
java.lang.String |
IDfPlugin.getUsage()
Gets the usage of this plugin.
|
boolean |
IDfContainment.getUseNodeVerLabel()
Indicates whether the component's version label is used to resolve descendent late-bound components.
|
IDfUser |
IDfSession.getUser(java.lang.String userName)
Returns a user object that contains information about the repository user.
|
IDfId |
IDfPolicy.getUserActionId(int index)
Return the attribute user_action_id value at the specified index.
|
int |
IDfPolicy.getUserActionIdCount()
Return the number of attribute user_action_id values for this policy.
|
java.lang.String |
IDfPolicy.getUserActionService(int index)
Return the attribute user_action_service value at the specified index.
|
int |
IDfPolicy.getUserActionServiceCount()
Return the number of user_action_service values for this policy.
|
java.lang.String |
IDfPolicy.getUserActionVer(int index)
Return the attribute user_action_ver value at the specified index.
|
int |
IDfPolicy.getUserActionVerCount()
Return the number of attribute user_action_ver values for this policy.
|
java.lang.String |
IDfUser.getUserAddress()
Returns the user's electronic mail address.
|
IDfUser |
IDfSession.getUserByLoginName(java.lang.String userLoginName,
java.lang.String userLoginDomain)
Returns a user object that contains information about the repository user.
|
IDfUser |
IDfSession.getUserByOSName(java.lang.String userOSName,
java.lang.String userOSDomain)
Returns a user object that contains information about the repository user.
|
double |
IDfWorkitem.getUserCost()
Returns the user assignable cost provided at completion time.
|
IDfId |
IDfPolicy.getUserCriteriaId(int index)
Return the attribute user_criteria_id value at the specified index.
|
int |
IDfPolicy.getUserCriteriaIdCount()
Return the number of attribute user_criteria_id values for this policy.
|
java.lang.String |
IDfPolicy.getUserCriteriaService(int index)
Return the attribute user_criteria_service value at the specified index.
|
int |
IDfPolicy.getUserCriteriaServiceCount()
Return the number of attribute user_criteria_service values for this policy.
|
java.lang.String |
IDfPolicy.getUserCriteriaVer(int index)
Return the attribute user_criteria_ver value at the specified index.
|
int |
IDfPolicy.getUserCriteriaVerCount()
Return the number of attribute user_criteria_ver values for this policy.
|
java.lang.String |
IDfUser.getUserDBName()
Returns the user's RDBMS user name.
|
java.lang.String |
IDfUser.getUserDelegation()
Returns the names of the user for workflow delegation.
|
java.lang.String |
IDfUser.getUserDistinguishedLDAPName()
Returns the user's distinguished name in LDAP.
|
java.lang.String |
IDfUser.getUserGroupName()
Returns the user's default group.
|
java.lang.String |
IDfUser.getUserLoginName()
Returns the user's Documentum user login name.
|
java.lang.String |
IDfUser.getUserName()
Returns the user's Documentum user name.
|
java.lang.String |
IDfUser.getUserOSDomain()
Returns the user's Windows NT domain name.
|
java.lang.String |
IDfUser.getUserOSName()
Returns the user's operating system user name.
|
java.lang.String |
IDfUser.getUserPassword()
Gets the user password for inline users.
|
java.lang.String |
IDfPolicy.getUserPostprocessingService(int index)
Return the attribute user_post_processing_service value at the specified index.
|
int |
IDfPolicy.getUserPostprocessingServiceCount()
Return the number of attribute user_post_processing_service values for this policy.
|
IDfId |
IDfPolicy.getUserPostprocId(int index)
Return the attribute user_postproc_id value at the specified index.
|
int |
IDfPolicy.getUserPostprocIdCount()
Return the number of attribute user_postproc_id values for this policy.
|
java.lang.String |
IDfPolicy.getUserPostprocVer(int index)
Return the attribute user_postproc_ver value at the specified index.
|
int |
IDfPolicy.getUserPostprocVerCount()
Return the number of attribute user_postproc_ver values for this policy.
|
int |
IDfUser.getUserPrivileges()
Returns the user's basic privileges.
|
IDfCollection |
IDfGroup.getUsersNames()
Returns a collection of user members' names in this group.
|
java.lang.String |
IDfGroup.getUsersNames(int index)
Returns the name of the user in a group object at a specified index.
|
int |
IDfGroup.getUsersNamesCount()
Returns the number of users in a Group object.
|
int |
IDfUser.getUserSource()
Deprecated.
As of DFC 5.2.5, replaced by getUserSourceAsString()
|
java.lang.String |
IDfUser.getUserSourceAsString()
Returns this user's source.
|
int |
IDfUser.getUserState()
Returns the availability of a user to process workitems.
|
int |
IDfWorkitem.getUserTime()
Returns the user assignable time provided at completion time.
|
java.lang.String |
IDfPolicy.getUserValidationService()
Return the attribute user_validation_service value for this policy.
|
int |
IDfUser.getUserXPrivileges()
Returns the user's extended privileges.
|
IDfValidator |
IDfPersistentObject.getValidator()
Returns the IDfValidator interface that is assocated with this persistent object instance (the
IDfValidator shall provide validation-related services).
|
IDfValue |
IDfTypedObject.getValue(java.lang.String attributeName)
Returns the value of an attribute asn an IDfValue object.
|
IDfValueAssistance |
IDfValidator.getValueAssistance(java.lang.String attrName,
IDfProperties depAttrValues)
Returns the value assistance associated with the specified attribute.
|
IDfProperties |
IDfValidator.getValueAssistanceDependencies(java.lang.String attrName)
Return the list of attributes on which the value assistance selection
depends on.
|
IDfValue |
IDfTypedObject.getValueAt(int index)
Returns the value stored in the attribute at the specified attribute index.
|
int |
IDfTypedObject.getValueCount(java.lang.String attributeName)
Returns the number of values stored in an attribute.
|
java.lang.String |
IDfVirtualDocumentNode.getVDMNumber()
Returns the node's number in the virtual document tree.
|
IDfCollection |
IDfSysObject.getVdmPath(IDfId rootId,
boolean shortestPath,
java.lang.String versionList)
Returns the path or paths through a virtual document that lead to a particular component.
|
IDfCollection |
IDfSysObject.getVdmPathDQL(IDfId rootId,
boolean shortestPath,
java.lang.String parentType,
java.lang.String bindingLabel,
java.lang.String nodeSortBy)
Returns the path or paths through a virtual document that lead to a particular component.
|
IDfVersionLabels |
IDfVersionTreeLabels.getVersion(int index)
Returns the IDfVersionLabels object for a given version.
|
int |
IDfVersionTreeLabels.getVersionCount()
Returns a count of the object versions in the version tree.
|
java.lang.String |
IDfContainment.getVersionLabel()
Returns the version label of the component represented by the containment object.
|
java.lang.String |
IDfVersionTreeLabels.getVersionLabel(int index)
Returns the version label at a specified index.
|
java.lang.String |
IDfVersionLabels.getVersionLabel(int index)
Returns the version label at a given index position.
|
java.lang.String |
IDfSysObject.getVersionLabel(int index)
Returns the version label at the specified index.
|
int |
IDfVersionLabels.getVersionLabelCount()
Returns a count of all the version labels associated with the SysObject.
|
int |
IDfSysObject.getVersionLabelCount()
Returns the number of version labels.
|
int |
IDfVersionTreeLabels.getVersionLabelCount(boolean includeImplicit,
boolean symbolicFirst)
Returns a count of the version labels in the object's version tree.
|
IDfVersionLabels |
IDfSysObject.getVersionLabels()
Returns an IDfVersionLabels object associated with this sysobject.
|
IDfVersionPolicy |
IDfSysObject.getVersionPolicy()
This will extract all the version labels associated with this object
and return the results as an IDfVersionPolicy interface.
|
IDfCollection |
IDfSysObject.getVersions(java.lang.String attrNames)
Runs a query to find all the versions of the object and returns the
query results as a collection.
|
java.lang.String |
IDfVersionPolicy.getVersionSummary(java.lang.String separator)
Returns all implicit and symbolic version labels associated
with a SysObject.
|
IDfVersionTreeLabels |
IDfSession.getVersionTreeLabels(IDfId chronicleId)
Returns the version labels associated with the versions of a SysObject.
|
int |
IDfPersistentObject.getVStamp()
Returns the version stamp for this object.
|
java.lang.String |
IDfValidator.getWidgetType(int environment,
java.lang.String attrName)
Find the appropriate widget type given a specific
development environment and attribute name.
|
java.lang.String |
IDfPersistentObject.getWidgetType(int environment,
java.lang.String attrName)
Deprecated.
use getValidator and then call getWidgetType on IDfValidator instead
|
java.lang.String |
IDfFormat.getWin31App()
Retrieves the name of the Windows application to launch when users select a document in this format.
|
java.lang.String |
IDfMountPoint.getWinPreferredAlias()
Gets the Windows preferred alias of this mount point.
|
IDfWorkflow |
IDfWorkflowBuilder.getWorkflow()
Returns the workflow object.
|
IDfId |
IDfWorkflowBuilder.getWorkflowAliasSetId()
Returns the alias set object id of the workflow object.
|
IDfId |
IDfWorkitem.getWorkflowId()
Returns the object ID of the workflow that contains this work item.
|
IDfId |
IDfWorkflowAttachment.getWorkflowId()
Gets the workflow ID.
|
IDfId |
IDfPackage.getWorkflowId()
Returns the workflow id.
|
IDfCollection |
IDfSysObject.getWorkflows(java.lang.String additionalAttributes,
java.lang.String orderBy)
Returns a collection of workflows the document currently participates in.
|
IDfWorkitem |
IDfQueueItem.getWorkitem()
Returns the work item object associated with the queue item.
|
int |
IDfUser.getWorldDefPermit()
Returns the default world permission assigned to objects created by a user.
|
int |
IDfSysObject.getWorldPermit()
Returns the object-level permission assigned to the world for the object.
|
int |
IDfSysObject.getXPermit(java.lang.String accessorName)
Returns the extended permissions, in integer form, for a specified user or group using the computed attribute
_xpermit.
|
int |
IDfACL.getXPermit(java.lang.String accessorName)
Returns the extended permissions assigned to a user or group.
|
java.lang.String |
IDfSysObject.getXPermitList()
Returns a list of extended permissions, separated by a comma, and supported by the server, using the computed
attribute _xpermit_list.
|
java.lang.String |
IDfACL.getXPermitList()
Returns a full list of the extended permissions, in string form, currently supported by the current server.
|
java.lang.String |
IDfSysObject.getXPermitNames(java.lang.String accessorName)
Returns the extended permissions of a specified user or group, in string form, in upper case, and separated by a
comma.
|
java.lang.String |
IDfACL.getXPermitNames(java.lang.String accessorName)
Returns the list of the extended permissions, in string form, for the specified user or group.
|
void |
IDfSysObject.grant(java.lang.String accessorName,
int accessorPermit,
java.lang.String extendedPermission)
Creates an access control entry in this object, assigning
an access level to a specified user or group.
|
void |
IDfACL.grant(java.lang.String accessorName,
int accessorPermit,
java.lang.String extendedPermitNames)
Sets permissions for a user or group in an ACL object.
|
void |
IDfSysObject.grantPermit(IDfPermit permit)
Creates an access control entry in this object, assigning
an access level to a specified user or group.
|
void |
IDfACL.grantPermit(IDfPermit permit)
Creates an access control entry in this object, assigning an access level to a specified user or group.
|
void |
IDfRouter.halt()
Deprecated.
|
void |
IDfWorkflow.halt(int activitySeqNo)
Halts an activity.
|
void |
IDfWorkflow.haltAll()
Halts the workflow.
|
void |
IDfWorkflow.haltEx(int activitySeqNo,
int suspendInterval)
Halts an activity with a suspend interval.
|
boolean |
IDfTypedObject.hasAttr(java.lang.String attributeName)
Indicates whether an attribute exists for this object.
|
boolean |
IDfActivity.hasCompatibilityRouteCases()
Indicates whether or not this activity supports compatibility (pre-5.3) route cases.
|
boolean |
IDfUser.hasEvents()
Returns
true , if the user is registered for auditable events; false otherwise. |
boolean |
IDfSession.hasEvents()
Indicates whether a user's inbox contains unread items.
|
boolean |
IDfTypeInfo.hasFullTextOnlyFtIndexAttrs() |
boolean |
IDfTypeInfo.hasFullTextSupportBase() |
boolean |
IDfTypeInfo.hasFullTextSupportLite() |
boolean |
IDfMethodObject.hasMethodContent()
Indicates if this method has content.
|
boolean |
IDfSysObject.hasPermission(java.lang.String permission,
java.lang.String accessorName)
Returns whether there is an access control entry in this object to a
specified user or group.
|
boolean |
IDfACL.hasPermission(java.lang.String permissionName,
java.lang.String accessorName)
Indicates whether a user or group has a specified extended permission.
|
boolean |
IDfTypeInfo.hasPropertyBag() |
boolean |
IDfUser.hasSession()
Check to see if this user has an active repository session.
|
boolean |
IDfVersionLabels.hasSymbolicVersionLabel()
Indicates whether the SysObject has symbolic labels.
|
boolean |
IDfValidator.hasValueAssistance(java.lang.String attrName)
Indicates whether value assistance is setup for the specified
attribute or not.
|
void |
IDfPlugin.importContent(java.lang.String filePath)
Import the content of this plugin.
|
boolean |
IDfSession.importTicketKey(java.lang.String key,
java.lang.String password)
Sets the given key, encrypted using the given password, as the login ticket key of the repository.
|
void |
IDfClient.initCrypto(java.lang.String keyFile)
Initializes the key store for password encryption.
|
void |
DfClient.initCrypto(java.lang.String keyFile) |
void |
IDfClient.initCryptoEx(java.lang.String keyFile,
java.lang.String passphrase)
Initializes the key store for password encryption.
|
void |
DfClient.initCryptoEx(java.lang.String keyFile,
java.lang.String passphrase) |
IDfId |
IDfWorkflowBuilder.initWorkflow()
Creates and saves the workflow object in the Documentum server.
|
void |
IDfTypedObject.insertBoolean(java.lang.String attributeName,
int valueIndex,
boolean value)
Inserts a boolean value into a repeating attribute.
|
void |
IDfSysObject.insertContent(java.io.ByteArrayOutputStream content,
int pageNumber)
Inserts new content into an object.
|
void |
IDfSysObject.insertContentEx(java.io.ByteArrayOutputStream content,
int pageNumber,
boolean other)
Inserts new content into an object.
|
void |
IDfTypedObject.insertDouble(java.lang.String attributeName,
int valueIndex,
double value)
Inserts a double value into a repeating attribute.
|
void |
IDfSysObject.insertFile(java.lang.String fileName,
int pageNumber)
Inserts a new content file into an object.
|
void |
IDfSysObject.insertFileEx(java.lang.String fileName,
int pageNumber,
java.lang.String otherFileName)
Inserts a new content file into an object.
|
void |
IDfTypedObject.insertId(java.lang.String attributeName,
int valueIndex,
IDfId value)
Inserts an Object ID value into a repeating attribute.
|
void |
IDfTypedObject.insertInt(java.lang.String attributeName,
int valueIndex,
int value)
Inserts an integer value into a repeating attribute.
|
IDfId |
IDfSysObject.insertPart(IDfId componentID,
java.lang.String versionLabel,
IDfId beforeContainmentId,
double orderNo,
boolean orderNoFlag,
boolean useNodeVerLabel,
boolean followAssembly,
int copyChild)
Inserts a document into the list of virtual child documents for the object.
|
void |
IDfPolicy.insertState(int index)
Insert a new state with the given index into this lifecycle.
|
void |
IDfTypedObject.insertString(java.lang.String attributeName,
int valueIndex,
java.lang.String value)
Inserts a string value into a repeating attribute.
|
void |
IDfRouter.insertTask(int position)
Deprecated.
|
void |
IDfTypedObject.insertTime(java.lang.String attributeName,
int valueIndex,
IDfTime value)
Inserts a date/time value into a repeating attribute.
|
void |
IDfTypedObject.insertValue(java.lang.String attributeName,
int valueIndex,
IDfValue value)
Inserts a variant value into a repeating attribute.
|
void |
IDfActivity.install()
Installs a validated activity.
|
void |
IDfPolicy.install(boolean notify)
Validate this policy.
|
void |
IDfProcess.install(boolean installActivity,
boolean resume)
Installs a validated workflow definition.
|
void |
IDfVersionTreeLabels.invalidate()
Flushes the cached information for the IDfVersionTreeLabels object.
|
void |
IDfProcess.invalidate()
Moves the validated workflow definition back to the draft state.
|
void |
IDfActivity.invalidate()
Moves a validated activity to the draft state.
|
boolean |
IDfSession.isACLDocbase()
Indicates whether repository identified as the default repository scope is operating in ACL mode.
|
boolean |
IDfSession.isAdopted()
Deprecated.
|
boolean |
IDfSysObject.isArchived()
Returns the a_archive attribute of the object.
|
boolean |
IDfTypeInfo.isAttrFullTextIndexed(java.lang.String attrName) |
boolean |
IDfTypedObject.isAttrRepeating(java.lang.String attributeName)
Indicates whether an attribute is a repeating attribute.
|
boolean |
IDfTypeInfo.isAutoMaterializationAllowed() |
boolean |
IDfVirtualDocumentNode.isBindingBroken()
Indicates whether there is a version in the node's version tree
that matches the binding criteria.
|
boolean |
IDfSysObject.isCheckedOut()
Returns whether this object is checked out.
|
boolean |
IDfSysObject.isCheckedOutBy(java.lang.String userName)
Returns whether this object is checked out by the specified user.
|
boolean |
IDfDumpRecord.isComplete() |
boolean |
IDfVirtualDocumentNode.isCompound()
Indicates whether users can add to, remove, or reorder this node
in the VDM display.
|
boolean |
IDfSysObject.isContentTransferCapabilityEnabled(java.lang.String networkLocationIdentifier,
IDfContentTransferCapability capability)
Returns whether content transfer capability is enabled for the object
|
boolean |
IDfVersionPolicy.isDefaultRetainLockOnCheckin()
Indicates whether to retain the lock on an object after it is
checked into the repository.
|
boolean |
IDfWorkitem.isDelegatable()
Indicates whether the work item can be delegated.
|
boolean |
IDfPersistentObject.isDeleted()
Returns
true if this object has been deleted during this session. |
boolean |
IDfQueueItem.isDeleteFlag()
Indicates whether the queued item has been dequeued.
|
boolean |
IDfPersistentObject.isDirty()
Indicates whether unsaved changes have been made to this object.
|
boolean |
IDfAuditTrailManager.isEventAudited(IDfId objectId,
java.lang.String event)
Indicates if this event is currently being audited for the object.
|
boolean |
IDfAuditTrailManager.isEventAuditedForType(java.lang.String typeName,
java.lang.String event,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName)
Indicates if this event is currently being audited for the object type.
|
boolean |
IDfWorkitem.isExecLaunch()
Indicates whether the application failed.
|
boolean |
IDfActivity.isExecSaveResults()
Indicates whether the results of the activity's actions are saved to a document.
|
boolean |
IDfWorkitem.isExecTimeOut()
Indicates whether the application timed out.
|
boolean |
IDfTypeInfo.isFetchOptimizedAspectType() |
boolean |
IDfLoadRecord.isFirstPhase() |
boolean |
IDfVirtualDocumentNode.isFromAssembly()
Indicates whether this node was selected from an assembly.
|
boolean |
IDfSysObject.isFrozen()
Returns whether this object was specifically frozen and is now unchangeable.
|
boolean |
IDfUser.isGloballyManaged()
Indicates whether the ACL associated with a user is managed globally or locally.
|
boolean |
IDfGroup.isGloballyManaged()
Indicates whether the ACL associated with a group object is globally or locally managed.
|
boolean |
IDfACL.isGloballyManaged()
Indicates whether an ACL object is managed globally or locally.
|
boolean |
IDfUser.isGroup()
Returns a Boolean value indicating whether a user is a group or an individual user.
|
boolean |
IDfACL.isGroup(int index)
Indicates if an accessor name in an ACL object is a group or a user.
|
boolean |
IDfGroup.isGroupInGroup(java.lang.String groupName)
Determines whether the group is one of the members of this group.
|
boolean |
IDfSysObject.isHidden()
Indicates if this object is visible to the end users.
|
boolean |
IDfFormat.isHidden()
Indicates whether a format is hidden from users.
|
boolean |
IDfSysObject.isImmutable()
Returns whether this object can be changed.
|
boolean |
IDfDumpRecord.isIncludeContent() |
boolean |
IDfPersistentObject.isInstanceOf(java.lang.String typeName)
Indicates if this is an object of the given type or of a type derived from the given type.
|
boolean |
IDfACL.isInternal()
Indicates whether an ACL object was created explicitly by the user or implicitly by the server.
|
boolean |
IDfMethodObject.isLaunchAsync() |
boolean |
IDfMethodObject.isLaunchDirect() |
boolean |
IDfSysObject.isLinkResolved()
Returns the a_link_resolved attribute of the object.
|
boolean |
IDfWorkitem.isManualExecution()
Indicates whether the work item's associated activity is a manual activity.
|
boolean |
IDfWorkitem.isManualTransition()
Indicates whether the work item's transition is manual.
|
boolean |
IDfPackage.isManufactured()
This method returns
true if this is a package that was
manually created by the user and did not come in on an INPUT port. |
boolean |
IDfTypeInfo.isMaterializationAllowed() |
boolean |
IDfLightObject.isMaterialized()
Indicates whether the lightobject is materialized.
|
boolean |
IDfDumpRecord.isMore() |
boolean |
IDfPersistentObject.isNew()
Indicates whether this object was created during the current session but has not yet been saved.
|
boolean |
IDfTypedObject.isNull(java.lang.String attributeName)
Reserved for future use.
|
boolean |
IDfSysObjectRetention.isObjectUnderRetention()
Returns true if the object is under retention.
|
boolean |
IDfSysObjectRetention.isObjectUnderRetentionHold()
Returns true is the object is under retention-hold.
|
boolean |
IDfActivity.isPostTimerRepeatLastAction()
Indicates if the final timer in the series should repeat.
|
boolean |
IDfActivity.isPreTimerRepeatLastAction()
Indicates if the final timer in the series should repeat.
|
boolean |
IDfProcess.isPrivate()
Indicates whether the workflow is private or public.
|
boolean |
IDfGroup.isPrivate()
Indicates whether a group object is private or public.
|
boolean |
IDfActivity.isPrivate()
Indicates whether the activity is a public or private activity.
|
boolean |
IDfSysObject.isPublic()
Returns whether the object is public or not.
|
boolean |
IDfQueueItem.isReadFlag()
Indicates whether the queued item has been read by the queue's owner.
|
boolean |
IDfSysObject.isReference()
Returns whether the object is a reference object.
|
boolean |
IDfLoadRecord.isRelocate() |
boolean |
IDfSession.isRemote()
Deprecated.
|
boolean |
IDfQueueItem.isRemotePending()
Indicates whether the queued item is waiting for distribution.
|
boolean |
IDfWorkitem.isRepeatable()
Indicates whether the work item can be repeated.
|
boolean |
IDfActivity.isRepeatableInvoke()
Indicates whether the activity can be invoked multiple times when the
workflow is running.
|
boolean |
IDfPersistentObject.isReplica()
Indicates whether an object is a replica.
|
boolean |
IDfFormat.isRichmediaEnabled() |
boolean |
IDfVirtualDocumentNode.isRoot()
Indicates whether the node is the root of the virtual document tree.
|
boolean |
IDfMethodObject.isRunAsServer() |
boolean |
IDfWorkflowBuilder.isRunnable()
Indicates whether the workflow's definition is in the installed state.
|
boolean |
IDfContentCollection.isSeekable() |
boolean |
IDfSession.isServerTraceOptionSet(java.lang.String optionName)
Queries the status of server-side tracing options for the session.
|
boolean |
IDfSession.isShared()
Indicates whether the session is a shared DFC session.
|
boolean |
IDfWorkitem.isSignOffRequired()
Indicates whether the work item requires a sign off.
|
boolean |
IDfQueueItem.isSignOffRequired()
Indicates whether a sign off is required for the work item or task.
|
boolean |
IDfVirtualDocumentNode.isStructurallyModified()
Indicates whether the node is structurally modified or not.
|
boolean |
IDfType.isSubTypeOf(java.lang.String typeName)
Indicates whether a type is a subtype of type
typeName . |
boolean |
IDfUser.isSuperUser()
Indicates whether a user has the SUPERUSER privilege for the current repository.
|
boolean |
IDfSysObject.isSuspended()
Return whether the object is in a suspended state.
|
boolean |
IDfUser.isSystemAdmin()
Indicates whether a user has the SYSADMIN privilege for the current repository.
|
boolean |
IDfMethodObject.isTraceLaunch() |
boolean |
IDfSession.isTransactionActive()
Checks if there is an active transaction.
|
boolean |
IDfType.isTypeAttrRepeating(java.lang.String attrName)
Indicates whether an attribute is repeating.
|
boolean |
IDfType.isTypeAttrRepeatingAt(int index)
Indicates whether an attribute is repeating.
|
boolean |
IDfType.isTypeOf(java.lang.String typeName)
Returns true if an object of this type is also an object of type
typeName . |
boolean |
IDfMethodObject.isUseMethodContent() |
boolean |
IDfMethodObject.isUseMethodServer() |
boolean |
IDfGroup.isUserInGroup(java.lang.String userName)
Determines whether the user is one of the members of this group.
|
boolean |
IDfLocation.isValidate()
Determines whether this location validates.
|
boolean |
IDfValueAssistance.isValidForDependentValues(IDfProperties depAttrValues)
Indicate whether the value assistance is valid or not.
|
boolean |
IDfValueAssistance.isValidForObject(IDfPersistentObject objectInstance)
Indicate whether the value assistance is valid or not.
|
boolean |
IDfVirtualDocumentNode.isVirtualDocument()
Indicates whether the node is a virtual document.
|
boolean |
IDfSysObject.isVirtualDocument()
Returns true if this document should be treated as a virtual document.
|
boolean |
IDfUser.isWorkflowDisabled()
Returns a boolean value indicating the user's availability for workflow.
|
void |
IDfSession.killSession(IDfId sessionId,
java.lang.String immediacyLevel,
java.lang.String message)
Kill the specified server session.
|
void |
IDfSysObject.link(java.lang.String folderSpec)
Associates the object with a folder or cabinet.
|
IDfEnumeration |
IDfModuleRegistry.list(IDfModuleFilter filter)
Get a list of all business objects available if they satisfy the filter.
|
IDfCollection |
IDfSession.listMetricsState()
Retrieves the state of all the metrics that are gatherable from the server.
|
void |
IDfPersistentObject.lock()
Acquires a low-level repository database lock on the object.
|
void |
IDfPersistentObject.lockEx(boolean validateStamp)
Acquires a low-level repository database lock on the object.
|
boolean |
IDfSession.makeActive()
Makes a request to move the server to which this session is connected to an active state
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
boolean |
IDfSession.makeActive(boolean allServersForThisDocbase)
Makes a request to move the docbase or server to an active state
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
void |
IDfSysObject.mark(java.lang.String versionLabels)
Assigns one or more symbolic version labels to an object.
|
void |
IDfLightObject.materialize()
Explicitly triggers the lightobject to be materialized, meaning
that the lightobject will now have its private parent instead of
a shared parent
|
void |
IDfSysObject.mount(java.lang.String path)
Deprecated.
|
void |
IDfPolicy.moveState(int oldIndex,
int newIndex)
Move a state within this policy.
|
IDfAttributeValueCondition |
IDfActivity.newAttributeValueCondition()
Factory method for attribute value transition conditions.
|
void |
IDfBatchManager.newGroup()
Start a new group in the current batch.
|
IDfPersistentObject |
IDfSession.newLightObject(java.lang.String typeName,
IDfId parentId)
Creates a persistent light type object given a specified Documentum server shareable type.
|
IDfPersistentObject |
IDfSession.newObject(java.lang.String typeName)
Creates a persistent object given a specified Documentum server type.
|
IDfPersistentObject |
IDfSession.newObjectWithType(java.lang.String typeName,
java.lang.String classNameIgnored)
Deprecated.
|
com.documentum.operations.IDfOperationManager |
IDfClient.newOperationManager()
Returns operation manager.
|
com.documentum.operations.IDfOperationManager |
DfClient.newOperationManager() |
IDfRetainer |
IDfRetainerFactory.newRetainerForContainer(IDfPersistentObject rootObject)
Creates IDfRetainer to apply retention to a group of objects.
|
IDfRetainer |
IDfRetainerFactory.newRetainerForContainerId(IDfSession session,
IDfId rootObjectId)
Creates IDfRetainer to apply retention to a group of objects.
|
IDfRetainer |
IDfRetainerFactory.newRetainerForObject(IDfPersistentObject rootObject)
Creates IDfRetainer to apply retention to a single object.
|
IDfRetainer |
IDfRetainerFactory.newRetainerForObjectId(IDfSession session,
IDfId rootObjectId)
Creates IDfRetainer to apply retention to a single object.
|
IDfSession |
IDfClient.newSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo)
Factory method that always constructs a new
IDfSession object and establishes a new session with the
specified Documentum server. |
IDfSession |
DfClient.newSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo) |
IDfStateExtension |
IDfPolicy.newStateExtension(int stateNo)
Create and initialize an IDfStateExtension for the specified state.
|
IDfWorkflowBuilder |
IDfSession.newWorkflowBuilder(IDfId processId)
Creates a workflow builder object.
|
IDfXPathCondition |
IDfActivity.newXPathCondition()
Factory method for XPath transition conditions.
|
boolean |
IDfCollection.next()
Gets the next row in a collection.
|
void |
IDfSysObjectRetention.onObjectRetained()
A function that is called by RPS after an object was retained.
|
void |
IDfSessionManagerEventListener.onSessionCreate(IDfSession session)
This method is called only when session manager has to create a new session object.
|
void |
IDfSessionManagerEventListener.onSessionDestroy(IDfSession session)
Deprecated.
|
void |
IDfBatchManager.openBatch()
This openBatch() method opens an insert batch, using default values.
|
void |
IDfBatchManager.openBatch(int size,
boolean flushBatchOnQuery,
boolean oneAuditPerBatch,
boolean oneEventPerBatch,
java.util.Properties options)
Opens an insert batch.
|
void |
IDfBatchManager.openBatchGroup(int size,
boolean flushBatchOnQuery,
boolean oneAuditPerBatch,
boolean oneEventPerBatch,
java.lang.String ignoreInsertError)
Opens an insert batch that uses groups.
|
java.util.List<IDfPair<IDfId,java.lang.String>> |
IDfEventManager.parseBatchedIds(IDfId eventId)
When oneEventPerBatch flag is turned on for a batch, the batch will generate a dm_batch_flush
event for objects created inside the batch.
|
java.util.List<IDfPair<IDfId,java.lang.String>> |
IDfAuditTrailManager.parseBatchedIds(IDfId audittrailId)
Get a list of BatchAudit from an audittrail object.
|
void |
IDfWorkitem.pause()
Pauses the work item.
|
void |
IDfRouter.pause(int taskNumber)
Deprecated.
|
java.lang.String |
IDfSysObject.print(java.lang.String printer,
boolean printCover,
boolean saveOutput,
int numCopies,
int startingContentPage,
int endingContentPage)
Prints the object.
|
boolean |
IDfSession.projectActiveStatus()
Only projects to docbroker that this server is active.
|
boolean |
IDfSession.projectDormantStatus()
Only projects to docbroker that this server is dormant.
|
void |
IDfSysObject.promote(java.lang.String state,
boolean override,
boolean fTestOnly)
Promotes the sysobject to the state specified in the
state
argument. |
void |
IDfSysObject.prune(boolean keepLabels)
Removes unwanted versions of an object.
|
void |
IDfSession.publishDataDictionary(java.lang.String locale,
java.lang.String typeName,
java.lang.String attributeName,
boolean forcePublish)
Publish Data Dictionary information.
|
void |
IDfSession.purgeLocalFiles()
Removes all files that have been copied into the local area during the current session.
|
IDfId |
IDfWorkitem.queue(java.lang.String user,
java.lang.String eventType,
int priority,
boolean sendMail,
IDfTime dueDate,
java.lang.String message)
Sends an event to a workitem.
|
IDfId |
IDfWorkflow.queue(java.lang.String supervisor,
java.lang.String eventType,
int priority,
boolean sendMail,
IDfTime dueDate,
java.lang.String message)
Sends an event to a workflow.
|
IDfId |
IDfSysObject.queue(java.lang.String queueOwner,
java.lang.String event,
int priority,
boolean sendMail,
IDfTime dueDate,
java.lang.String message)
Places the object on a specified queue.
|
void |
IDfRouter.reAssign(int taskNumber,
java.lang.String taskOwner,
java.lang.String message)
Deprecated.
|
void |
IDfSysObject.refreshReference()
Refreshes the reference object.
|
void |
IDfAuditTrailManager.registerEvent(IDfId objectId,
java.lang.String event)
Registers an event for the object.
|
void |
IDfPersistentObject.registerEvent(java.lang.String message,
java.lang.String event,
int priority,
boolean sendMail)
Registers the current user to receive notifications when the
specified event occurs on the specified object.
|
void |
IDfAuditTrailManager.registerEventForObject(IDfId objectId,
java.lang.String event,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList)
Registers an event for object instance.
|
void |
IDfAuditTrailManager.registerEventForObjectEx(IDfId objectId,
java.lang.String event,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList,
boolean eSignatureRequired)
Registers an event for object instance.
|
void |
IDfAuditTrailManager.registerEventForObjectEx2(IDfId objectId,
java.lang.String event,
boolean auditSubtypes,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList,
boolean eSignatureRequired)
Registers an event for object type.
|
void |
IDfAuditTrailManager.registerEventForType(java.lang.String typeName,
java.lang.String event,
boolean auditSubtypes,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList)
Registers an event for object type.
|
void |
IDfAuditTrailManager.registerEventForTypeEx(java.lang.String typeName,
java.lang.String event,
boolean auditSubtypes,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList,
boolean eSignatureRequired)
Registers an event for object type.
|
void |
IDfAuditTrailManager.registerEvents(IDfId objectId,
IDfList events)
Registers a list of events for the object.
|
void |
IDfAuditTrailManager.registerEventsFromQuery(java.lang.String query,
IDfList events)
Registers the events specified in IDflist for the objects returned by the query.
|
void |
IDfAuditTrailManager.registerEventsInFolder(IDfId folderId,
IDfList events)
Registers a list of events for all sysobjects under the folder.
|
void |
IDfSession.reInit(java.lang.String serverConfigName)
Reinitializes a server's root and spawned processes.
|
void |
IDfSession.reInitEx(java.lang.String serverConfigName,
boolean sendToDocBroker)
Reinitializes a server's root and spawned processes.
|
void |
IDfTypedObject.remove(java.lang.String attributeName,
int valueIndex)
Removes a value stored in a repeating attribute.
|
void |
IDfProcess.removeActivity(java.lang.String actName)
Removes an activity from the workflow definition.
|
void |
IDfProcess.removeActPerformer(int index)
Remove the act_performer_rule/act_performer_from/act_performer_to
values at the corresponding index position.
|
void |
IDfAliasSet.removeAlias(java.lang.String name)
Removes an alias from the alias set.
|
void |
IDfTypedObject.removeAll(java.lang.String attributeName)
Removes all values stored in a repeating attribute.
|
void |
IDfAliasSet.removeAllAliases()
Removes all the aliases in the alias set.
|
void |
IDfVirtualDocument.removeAllChangeDescriptions(java.lang.String contextTag)
Removes all the changes made in a particular VDM window.
|
void |
IDfGroup.removeAllGroups()
Removes all groups from this group.
|
void |
IDfGroup.removeAllUsers()
Removes all users from this group.
|
void |
IDfSessionManagerConfig.removeApplicationCode(java.lang.String value) |
void |
IDfWorkitem.removeAttachment(IDfId attachmentId)
Removes an attachment from the workflow.
|
void |
IDfWorkflow.removeAttachment(IDfId attachmentId)
Removes an attachment from the workflow.
|
void |
IDfVirtualDocument.removeChangeDescription(IDfId objectId)
Removes the change or changes made to a node.
|
void |
IDfPersistentObject.removeChildRelative(java.lang.String relationTypeName,
IDfId childId,
java.lang.String childLabel)
This method should be invoked on the parent object to abandon its relationship with one or more
children.
|
void |
IDfSysObject.removeContent(int pageNumber)
Deletes content from an object.
|
boolean |
IDfClient.removeContext(java.lang.String contextId)
Deletes a
IDfProperties object containing client information. |
boolean |
DfClient.removeContext(java.lang.String contextId) |
void |
IDfDocbrokerClient.removeDocbroker(java.lang.String hostName,
int portNumber)
Dynamically removes a connection broker that was added using
IDfDocbrokerClient.addDocbroker(java.lang.String, int) . |
void |
IDfAdminClient.removeDocbroker(java.lang.String hostName,
int portNumber)
Dynamically removes a connection broker that was added using
IDfAdminClient.addDocbroker(java.lang.String, int) . |
void |
IDfSessionManagerConfig.removeDynamicGroup(java.lang.String value) |
void |
IDfSession.removeDynamicGroup(java.lang.String groupName)
Removes the session user from the dynamic group for this session.
|
boolean |
IDfGroup.removeGroup(java.lang.String groupName)
Add a group to this group.
|
void |
IDfProcess.removeLink(java.lang.String linkName)
Removes a link from the workflow definition.
|
void |
IDfMethodObject.removeMethodContent()
Removes the content of the method.
|
void |
IDfVirtualDocument.removeNode(IDfVirtualDocumentNode node)
Removes a node from the virtual document.
|
void |
IDfSysObject.removeNote(IDfId annotationId)
Deprecated.
|
void |
IDfPackage.removeNote(int noteIndex)
Removes an existing note from a package.
|
void |
IDfPackage.removeNoteEx(IDfId annotationId)
Removes an existing note from a package.
|
void |
IDfNote.removeNoteEx(IDfId targetId)
Detaches an annotation (the current IDfSysObject) from the target object.
|
void |
IDfWorkitem.removePackage(java.lang.String packageName)
Removes a package from the work item.
|
void |
IDfWorkflowBuilder.removePackage(java.lang.String activityName,
java.lang.String portName,
java.lang.String packagename)
Removes a package definition from an activity.
|
void |
IDfWorkflow.removePackage(java.lang.String startActivityName,
java.lang.String portName,
java.lang.String packageName)
Removes a package from a start activity in the workflow.
|
void |
IDfActivity.removePackageInfo(java.lang.String portName,
java.lang.String packageName)
Removes a package definition from the activity.
|
void |
IDfProcess.removePackageSchemaAssociation(java.lang.String packageName)
Removes the association of an XML schema document to a package.
|
void |
IDfPersistentObject.removeParentRelative(java.lang.String relationTypeName,
IDfId parentId,
java.lang.String childLabel)
This method should be invoked on the child object to abandon its relationship with one or more
parents.
|
void |
IDfSysObject.removePart(IDfId containmentId,
double orderNo,
boolean orderNoFlag)
Removes a virtual document child from the object.
|
void |
IDfActivity.removePerformerCondition(java.lang.String conditionName)
Removes a route case from the activity.
|
void |
IDfActivity.removePort(java.lang.String portName)
Removes a port from the activity.
|
void |
IDfActivity.removePostTimers()
Removes all pre-timers from this activity.
|
void |
IDfActivity.removePreTimers()
Removes all pre-timers from this activity.
|
void |
IDfSysObject.removeRendition(java.lang.String formatName)
Deletes a rendition from the object.
|
void |
IDfSysObject.removeRenditionEx(java.lang.String formatName,
int pageNumber,
boolean atomic)
Deletes a rendition from the object.
|
void |
IDfSysObject.removeRenditionEx2(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
boolean atomic)
Deletes a rendition from the object.
|
void |
IDfSysObjectRetention.removeRetention(IDfId retainerId)
Removes object from the control of retention services.
|
void |
IDfActivity.removeRouteCase(java.lang.String routeCaseIdentifier)
Removes a route case from the activity.
|
void |
IDfPolicy.removeState(int index)
Remove a state from this policy.
|
void |
IDfRouter.removeTask(int position)
Deprecated.
|
boolean |
IDfGroup.removeUser(java.lang.String userName)
Removes a user to this group.
|
void |
IDfGroup.renameGroup(java.lang.String groupName,
boolean isImmediate,
boolean unlockObjects,
boolean reportOnly)
Rename this group.
|
void |
IDfGroup.renameGroupEx(java.lang.String groupName,
boolean isImmediate,
boolean unlockObjects,
boolean reportOnly,
java.lang.String groupDisplayName)
Rename this group.
|
void |
IDfUser.renameUser(java.lang.String userName,
boolean isImmediate,
boolean unlockObjects,
boolean reportOnly)
Renames this user.
|
void |
IDfLightObject.reparent(IDfId newParentId)
Points the lightobject to a different parent.
|
void |
IDfSession.reparentLightObjects(IDfId newParentId,
IDfList childIds)
Reparents multiple lightweight objects at a time.
|
void |
IDfWorkitem.repeat(IDfList list)
Defines an extended round of work item performers.
|
boolean |
IDfSession.requestDormancy()
Makes a request to move the server to which this session is connected to a dormant state.
|
boolean |
IDfSession.requestDormancy(boolean allServersForThisDocbase)
Makes a request to move the docbase or server to a dormant state
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
boolean |
IDfSession.resetMetrics()
This is for resetting the metrics.
|
boolean |
IDfSession.resetPassword(java.lang.String password)
Resets password or login ticket associated with the user credential of the current session.
|
void |
IDfVirtualDocumentNode.resetSelectedVersionFromBinding()
Clears any temporary object selection and resets the node's selection based
on its defined binding.
|
void |
IDfVirtualDocument.resetSelectedVersionsFromBinding()
Clears temporary object selections and resets all node object selections
based on their defined bindings.
|
boolean |
IDfSession.resetTicketKey()
Generates an asymmetric key and sets it as the login ticket key of the repository.
|
java.lang.String |
IDfSession.resolveAlias(IDfId sysObject,
java.lang.String scopeAlias)
Returns the value mapped to a given alias.
|
java.lang.String |
IDfSysObject.resolveAlias(java.lang.String scopeAlias)
Searches an alias set for a specified alias.
|
void |
IDfWorkflow.restart(int activitySeqNo)
Restarts a failed activity in the workflow.
|
void |
IDfSession.reStart(java.lang.String serverConfigName,
boolean restartClient)
Reinitializes a server's spawned process to which the current session is connected.
|
void |
IDfWorkflow.restartAll()
Restarts a halted workflow.
|
void |
IDfWorkflow.restartEx(int activitySeqNo,
boolean manualComplete)
Restarts a failed activity in the workflow and indicates
whether the automatic task (if any) of this activity is intended to be
manually completed.
|
IDfId |
IDfSession.restore(java.lang.String predicate,
java.lang.String dumpFile,
java.lang.String operatorName,
int priority,
boolean sendMail,
IDfTime dueDate)
Queues a request to restore a content file or files from the archives.
|
void |
IDfWorkitem.resume()
Moves a paused work item to the dormant state.
|
void |
IDfWorkflow.resume(int activitySeqNo)
Moves a halted activity to the active state.
|
void |
IDfSysObject.resume(java.lang.String state,
boolean toBase,
boolean override,
boolean fTestOnly)
Resumes the sysobject from an exception state.
|
void |
IDfWorkflow.resumeAll()
Moves a halted workflow to the running state.
|
void |
IDfRouter.resumeRouter(int taskNumber)
Deprecated.
|
void |
IDfVirtualDocument.resync(IDfSession session,
IDfId objectId,
int flags)
Flushes all node information and synchronizes cached object attributes
with the repository.
|
void |
IDfRouter.reverse(int currentTask,
IDfList previousTask,
java.lang.String message)
Deprecated.
|
void |
IDfPersistentObject.revert()
Discards any changes to an object that have not been saved to a repository.
|
void |
IDfSysObject.revertACL()
Throws away unsaved permission changes.
|
void |
IDfSysObject.revoke(java.lang.String accessorName,
java.lang.String extendedPermission)
Removes all access control entries from this object for a
specified user or group.
|
void |
IDfACL.revoke(java.lang.String accessorName,
java.lang.String extendedPermitNames)
Removes all extended permissions granted to a user or group in an ACL object
You must execute either the
save , saveAsNew , or checkin method to commit
the granted permission to a repository. |
void |
IDfSysObject.revokePermit(IDfPermit permit)
Removes specified permit from the sysobject.
|
void |
IDfACL.revokePermit(IDfPermit permit)
Removes specified permit from the acl.
|
IDfId |
IDfWorkflowBuilder.runWorkflow()
Executes the workflow object.
|
void |
IDfPersistentObject.save()
Saves an object to a Documentum server.
|
IDfId |
IDfACL.saveAsNew()
Creates a new copy of the object. object is shared with the new object.
|
IDfId |
IDfSysObject.saveAsNew(boolean shareContent)
Copies an object.
|
void |
IDfSysObject.saveLock()
Writes the object to the repository without creating a new version
and directs the server to hold the intention lock on the saved object.
|
void |
IDfSysObject.scheduleDemote(java.lang.String state,
IDfTime schedule_date)
Schedules the sysobject to demote from its current normal state to
the state defined in the
state parameter. |
void |
IDfSysObject.schedulePromote(java.lang.String state,
IDfTime scheduleDate,
boolean override)
Schedules a sysobject to be promoted to the next state on a
particular date/time specified by the
scheduleDate
parameter. |
void |
IDfSysObject.scheduleResume(java.lang.String state,
IDfTime scheduleDate,
boolean toBase,
boolean override)
Schedules to resume the sysobject from an exception state to the
next state at the specified date/time.
|
void |
IDfSysObject.scheduleSuspend(java.lang.String state,
IDfTime scheduleDate,
boolean override)
Schedule a suspend of the sysobject from its
current state to the exception state at a certain date/time.
|
void |
IDfContentCollection.seek(int position,
int root)
Sets the starting position used by
IDfCollection.next() for reading the next buffer of a content collection. |
void |
IDfContentCollection.seekEx(long position,
int root)
Sets the starting position used by
IDfCollection.next() for reading the next buffer of a content collection. |
IDfId |
IDfSession.sendToDistributionList(IDfList toUsers,
IDfList toGroups,
java.lang.String instructions,
IDfList objectIDs,
int priority,
boolean endNotification)
|
IDfId |
IDfSession.sendToDistributionListEx(IDfList toUsers,
IDfList toGroups,
java.lang.String instructions,
IDfList objectIDs,
int priority,
int flags)
Creates and starts an ad-hoc workflow.
|
void |
IDfSysObject.setACL(IDfACL acl)
Assigns an ACL object to the object.
|
void |
IDfACL.setACLClass(int aclClass)
Sets the ACL class value.
|
void |
IDfSysObject.setACLDomain(java.lang.String aclDomain)
Sets the domain of the ACL associated with this user.
|
void |
IDfSysObject.setACLName(java.lang.String ACLName)
Sets the name of the associated ACL.
|
void |
IDfProcess.setActChooseBy(int index,
java.lang.String name)
Sets the act_choose_by attribute value at the specified index position.
|
void |
IDfProcess.setActChooseFor(int index,
java.lang.String name)
Sets the act_choose_for attribute at a specified index position.
|
void |
IDfProcess.setActChooseName(int index,
java.lang.String name)
Sets the act_choose_name attribute at a specified index position.
|
void |
IDfPolicy.setActionObjectId(int index,
IDfId value)
Set the attribute action_object_id value at the specified index.
|
void |
IDfRetainer.setAgingMethod(int aging_method)
Sets the dm_retainer.aging_method value.
|
void |
IDfAliasSet.setAliasCategory(int index,
int aliasCategory)
Sets the category for the alias in the specified index position
in the alias set.
|
void |
IDfAliasSet.setAliasDescription(int index,
java.lang.String aliasDescription)
Sets the description of the alias at the
specified index position in this alias set.
|
void |
IDfAliasSet.setAliasName(int index,
java.lang.String aliasName)
Sets the alias name at the specified index in this alias set.
|
void |
IDfUser.setAliasSet(java.lang.String aliasSetName)
Sets the default alias set for this user.
|
void |
IDfSession.setAliasSet(java.lang.String name)
Sets the alias_set attribute of this session_config.
|
void |
IDfGroup.setAliasSetId(IDfId aliasId)
Sets the alias set object id of the group.
|
void |
IDfPolicy.setAliasSetIds(int index,
IDfId value)
Set the attribute allias_set_ids value at the specified index.
|
void |
IDfAliasSet.setAliasUserCategory(int index,
int aliasUserCategory)
Sets the user category of the alias at the specified index
position in the alias set.
|
void |
IDfAliasSet.setAliasValue(int index,
java.lang.String aliasValue)
Sets the value corresponding to the alias at the specified index
in this alias set.
|
void |
IDfPolicy.setAllowAttach(int index,
boolean value)
Set the attribute allow_attach value at the specified index.
|
void |
IDfPolicy.setAllowDemote(int index,
boolean value)
Set the attribute allow_demote value at the specified index.
|
void |
IDfPolicy.setAllowSchedule(int index,
boolean value)
Set the attribute allow_schedule value at the specified index.
|
void |
IDfSysObject.setApplicationType(java.lang.String type)
Sets the a_application_type attribute of the object.
|
void |
IDfPolicy.setAppValidationId(IDfId value)
Set the attribute app_validation_id value for this policy.
|
void |
IDfPolicy.setAppValidationVer(java.lang.String value)
Set the attribute app_validation_ver value for this policy.
|
void |
IDfSysObject.setArchived(boolean archived)
Sets the a_archive attribute of the object.
|
void |
IDfVirtualDocumentNode.setAssemblyDocumentBinding(java.lang.String bindingValue)
Sets the binding between an assembly's associated document and that
document's parent in the virtual document tree.
|
void |
IDfFormat.setAssetClass(java.lang.String value) |
void |
IDfSysObject.setAuthors(int index,
java.lang.String author)
Sets the authors attribute at a specified index.
|
void |
IDfSession.setBatchHint(int batchSize)
Sets the maximum number of rows returned to the server for each call to the underlying RDBMS.
|
void |
IDfVirtualDocumentNode.setBinding(java.lang.String newBinding)
Defines a new version label to use to resolve the binding for this node.
|
void |
IDfAssembly.setBookId(IDfId parentObjectId)
Sets the book_id attribute of the assembly object.
|
void |
IDfTypedObject.setBoolean(java.lang.String attributeName,
boolean value)
Sets the boolean value of an attribute.
|
void |
IDfFormat.setCanIndex(boolean value) |
void |
IDfAspectRelation.setChild(java.lang.String name)
Sets the child aspect of an aspect relation object.
|
void |
IDfRelation.setChildId(IDfId child)
Sets the ID of the object that is the "child" in the relationship.
|
void |
IDfRelation.setChildLabel(java.lang.String label)
Sets the version label of the child in the relationship.
|
void |
IDfRelationType.setChildType(java.lang.String child)
Sets the object type of a valid child object in the
relationship.
|
void |
IDfUser.setClientCapability(int clientCapability)
Sets the client capability for this user
|
void |
IDfFormat.setComClassId(java.lang.String value) |
void |
IDfAssembly.setComponentChronicleId(IDfId chronId)
Sets the component_chron_id attribute of the assembly object.
|
void |
IDfAssembly.setComponentId(IDfId objectId)
Sets the component_id attribute of the assembly object.
|
void |
IDfSysObject.setCompoundArchitecture(java.lang.String compoundArchitecture)
Used by the virtual document manager to determine if the object can be changed.
|
void |
IDfAssembly.setContainDescription(java.lang.String containDesc) |
void |
IDfAssembly.setContainType(java.lang.String containType) |
boolean |
IDfSysObject.setContent(java.io.ByteArrayOutputStream content)
Sets new content to an object.
|
boolean |
IDfSysObject.setContentEx(java.io.ByteArrayOutputStream content,
java.lang.String format,
int pageNumber)
This is the extended method for setting the content of an object.
|
boolean |
IDfSysObject.setContentEx2(java.io.ByteArrayOutputStream content,
java.lang.String format,
int pageNumber,
boolean other)
This is the extended method for setting the content of an object.
|
void |
IDfSysObject.setContentType(java.lang.String contentType)
Sets the file format of the object's content.
|
void |
IDfActivity.setControlFlag(int flag)
Sets the control flag attribute of the activity.
|
void |
IDfRelationType.setControllingKind(java.lang.String val)
Sets the controlling kind attribute defined for the relation of this type.
|
void |
IDfVirtualDocumentNode.setCopyBehavior(int behavior)
Sets the copy behavior for the node.
|
void |
IDfRelationType.setCopyBehavior(int val)
Sets the copy behavior defined for the relation of this type.
|
void |
IDfRetainer.setDateRetentionPeriod(IDfTime retentionDate)
Specifies the retention period for the retainer.
|
void |
IDfUser.setDefaultACL(java.lang.String aclName)
Sets the default ACL for this user to a system ACL (owned by the repository owner).
|
void |
IDfUser.setDefaultACLEx(java.lang.String domainName,
java.lang.String aclName)
Sets the default ACL for this user.
|
void |
IDfUser.setDefaultFolder(java.lang.String folderPath,
boolean isPrivate)
Sets the default folder for this user.
|
void |
IDfScopeManager.setDefaultScope(com.documentum.fc.client.ScopeBoundary boundary,
boolean bNested)
Set the default scoping policy for a given boundary.
|
void |
IDfFormat.setDefaultStorage(IDfId value) |
void |
IDfAssembly.setDepth(int depth)
Sets the depth_no attribute of the assembly object.
|
void |
IDfUser.setDescription(java.lang.String description)
Sets the default description for this user.
|
void |
IDfRelationType.setDescription(java.lang.String desc)
Sets the user defined description of the relationship.
|
void |
IDfRelation.setDescription(java.lang.String desc)
Not system defined.
|
void |
IDfGroup.setDescription(java.lang.String description)
Sets the description of this group.
|
void |
IDfFormat.setDescription(java.lang.String value) |
void |
IDfACL.setDescription(java.lang.String description)
Sets the user-defined description of an ACL object.
|
void |
IDfRetainer.setDispositionRule(int dispositionRule)
Sets the dm_retainer.disposition_rule value.
|
java.lang.String |
IDfSession.setDocbaseScope(java.lang.String docbaseName)
THIS METHOD IS NOT THREAD SAFE.
|
java.lang.String |
IDfSession.setDocbaseScopeById(IDfId objectId)
THIS METHOD IS NOT THREAD SAFE.
|
void |
IDfDocbrokerClient.setDocbrokerModificationEnabled(boolean enable,
IDfSession session)
Enables or disables the dynamic adding and removing of connection brokers.
|
void |
IDfACL.setDomain(java.lang.String domain)
Sets the domain (owner name) of an ACL object.
|
void |
IDfFormat.setDOSExtension(java.lang.String value) |
void |
IDfTypedObject.setDouble(java.lang.String attributeName,
double value)
Sets the double value of an attribute.
|
void |
IDfSysObject.setDoubleContentAttribute(java.lang.String name,
double value,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Set a numeric content attribute.
|
void |
IDfDumpRecord.setDumpOperation(java.lang.String value) |
void |
IDfDumpRecord.setDumpParameter(int index,
java.lang.String value) |
void |
IDfDumpRecord.setDumpType(int index,
java.lang.String value) |
void |
IDfGroup.setDynamic(boolean isDynamic)
Marks the group as a dynamic group
|
void |
IDfGroup.setDynamicDefault(boolean isDynamicDefault)
Marks the dynamic group as having its membership be included by default for members when they connect.
|
void |
IDfRelation.setEffectiveDate(IDfTime date)
Not system defined.
|
void |
IDfRetainer.setEnforcementRule(int enforcementRule)
Sets the dm_retainer.enforcement_rule value.
|
void |
IDfPolicy.setEntryCriteria(int index,
java.lang.String value)
Set the entry criteria for the state with the given index.
|
void |
IDfPolicy.setExceptionState(int index,
java.lang.String value)
Set the attribute exception_state value at the specified index.
|
void |
IDfActivity.setExecErrHandling(int execErrHandling)
Sets the failure-handling protocol for the activity's execution.
|
void |
IDfActivity.setExecMethodId(IDfId execMethodId)
Identifies the method that executes the activity's actions.
|
void |
IDfActivity.setExecRetryInterval(int execRetryInterval)
Sets the retry interval if the activity's execution fails.
|
void |
IDfActivity.setExecRetryMax(int execRetryMax)
Sets the maximum retry number if the activity's execution fails.
|
void |
IDfActivity.setExecSaveResults(boolean execSaveResults)
Defines whether to save the results of an automatic activity execution.
|
void |
IDfActivity.setExecSubtype(int subType)
Defines the activity's exec_subtype.
|
void |
IDfActivity.setExecTimeOut(int execTimeOut)
Sets the time-out period for the method that executes the
activity's actions.
|
void |
IDfActivity.setExecType(int execType)
Defines the activity's execution type as manual or automatic.
|
void |
IDfRelation.setExpirationDate(IDfTime date)
Not system defined.
|
void |
IDfPolicy.setExtensionType(java.lang.String value)
Set the attribute extension_type value for this policy.
|
void |
IDfUser.setFailedAuthenticationAttempts(int failedAttempts)
Sets the number of failed attempts to authenticate the user.
|
void |
IDfSysObject.setFile(java.lang.String fileName)
Sets the content file of this object or replaces an existing content.
|
void |
IDfSysObject.setFileEx(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
java.lang.String otherFile)
This is the extended method for setting the content file of this
object, or it replaces existing content.
|
void |
IDfDumpRecord.setFileName(java.lang.String value) |
void |
IDfFormat.setFilenameModifier(java.lang.String value) |
void |
IDfMountPoint.setFileSystemPath(java.lang.String fileSystemPath)
Sets the file system path of this mount point.
|
void |
IDfLocation.setFileSystemPath(java.lang.String fileSystemPath)
Sets the file system path of this location.
|
void |
IDfVirtualDocumentNode.setFollowAssembly(boolean followAssembly)
Directs the system to use the node's assembly in the display.
|
void |
IDfFormat.setFormatClass(int index,
java.lang.String value) |
void |
IDfSysObject.setFullText(boolean fullText)
Sets whether the document is marked for full-text indexing.
|
void |
IDfUser.setGloballyManaged(boolean isGloballyManaged)
Sets the user as either global (managed by federation) or local.
|
void |
IDfGroup.setGloballyManaged(boolean isGloballyManaged)
Sets if this group is globally managed (by Federation) or local.
|
void |
IDfGroup.setGroupAddress(java.lang.String groupAddress)
Sets the e-mail address of this group.
|
void |
IDfGroup.setGroupAdmin(java.lang.String admin)
Sets the admin of this group.
|
void |
IDfGroup.setGroupClass(java.lang.String className)
Sets the class of this group.
|
void |
IDfGroup.setGroupDirectoryId(IDfId value) |
void |
IDfGroup.setGroupDisplayName(java.lang.String value)
Sets the display name of a group.
|
void |
IDfGroup.setGroupGlobalUniqueId(java.lang.String value) |
void |
IDfSysObject.setGroupName(java.lang.String name)
Set the group name to which this object belongs.
|
void |
IDfGroup.setGroupName(java.lang.String groupName)
Sets the name of this group.
|
void |
IDfGroup.setGroupNativeRoomId(IDfId value)
Sets the group native room id.
|
void |
IDfSysObject.setGroupPermit(int permit)
Sets the object-level group permission for the object.
|
void |
IDfGroup.setGroupSource(java.lang.String value) |
void |
IDfPlugin.setHardwarePlatform(java.lang.String platform)
Sets the hardware platform of this plugin.
|
void |
IDfSysObject.setHidden(boolean isHidden)
Sets the visibility of the object for end users.
|
void |
IDfFormat.setHidden(boolean value) |
void |
IDfUser.setHomeDocbase(java.lang.String docbaseName)
Sets this user's home repository.
|
void |
IDfMountPoint.setHostName(java.lang.String hostName)
Sets the host name of this mount point.
|
void |
IDfFormat.setIconIndex(int value) |
void |
IDfTypedObject.setId(java.lang.String attributeName,
IDfId value)
Sets the Object ID value of an attribute.
|
void |
IDfRetainer.setImmutabilityRule(int immutabilityRule)
Sets the dm_retainer.immutability_rule value.
|
void |
IDfVirtualDocument.setIncludeBrokenBindings(boolean shouldIncludeBroken)
Specifies whether to display nodes with broken bindings using the CURRENT label.
|
void |
IDfDumpRecord.setIncludeContent(boolean value) |
void |
IDfPolicy.setIncludedType(int index,
java.lang.String value)
Set the attribute included_typename attribute at the specified index.
|
void |
IDfPolicy.setIncludeSubtypes(int index,
boolean value)
Set the attribute include_subtypes value at the specified index.
|
void |
IDfWorkflow.setInitiateAct(java.lang.String actName)
Set initiate_act attribute of the workflow
|
void |
IDfWorkflow.setInstructions(int index,
java.lang.String instr)
Sets the instructions attribute at a specified index.
|
void |
IDfTypedObject.setInt(java.lang.String attributeName,
int value)
Sets the integer value of an attribute.
|
void |
IDfRetainer.setIntervalRetentionPeriod(int retentionInterval)
Specifies retention period for the retainer.
|
void |
IDfSysObject.setIsVirtualDocument(boolean is_virtual_doc)
Sets the r_is_virtual_doc attribute for the object.
|
void |
IDfPolicy.setJavaMethods(boolean value)
Set the attribute java_methods value for this policy.
|
void |
IDfSysObject.setKeywords(int index,
java.lang.String keyword)
Sets the keywords attribute at a specified index.
|
void |
IDfMethodObject.setLaunchAsync(boolean value) |
void |
IDfMethodObject.setLaunchDirect(boolean value) |
void |
IDfSysObject.setLinkResolved(boolean linkResolved)
Sets the a_link_resolved attribute of the object.
|
void |
IDfLoadRecord.setLoadFileName(java.lang.String value) |
void |
IDfLoadRecord.setLoadOperation(java.lang.String value) |
void |
IDfLoadRecord.setLoadParameter(int index,
java.lang.String value) |
void |
IDfLoadRecord.setLoadType(int index,
java.lang.String value) |
void |
IDfSessionManagerConfig.setLocale(java.lang.String value) |
void |
IDfSysObject.setLogEntry(java.lang.String logEntry)
Sets the comment specified by the user.
|
void |
IDfFormat.setMacCreator(java.lang.String value) |
void |
IDfMountPoint.setMacPreferredAlias(java.lang.String alias)
Sets the Macintosh preferred alias of this mount point.
|
void |
IDfFormat.setMacType(java.lang.String value) |
void |
IDfMethodObject.setMethodArgs(int index,
java.lang.String value) |
void |
IDfMethodObject.setMethodContent(java.lang.String filePath)
Sets the content of the method.
|
void |
IDfMethodObject.setMethodType(java.lang.String value) |
void |
IDfMethodObject.setMethodVerb(java.lang.String value) |
void |
IDfFormat.setMimeType(java.lang.String value) |
void |
IDfLocation.setMountPointName(java.lang.String mountPointName)
Sets the mount point name of this location.
|
void |
IDfFormat.setName(java.lang.String value) |
void |
IDfLocation.setNewMountPoint(java.lang.String path)
Sets the mount point of this location by passing the file system path of the
mount point.
|
void |
IDfRetainer.setNoRetentionPeriod()
Specifies retention rule for the retainer with no defined retention period.
|
void |
IDfTypedObject.setNull(java.lang.String attributeName)
Reserved for future use.
|
void |
IDfVirtualDocument.setNumberingScheme(IDfVDMNumberingScheme scheme)
Defines the numbering scheme for the virtual document display.
|
void |
IDfAliasSet.setObjectDescription(java.lang.String objectDescription)
Sets the description of the alias set.
|
void |
IDfWorkflow.setObjectName(java.lang.String objectName)
Sets the object name of a workflow object.
|
void |
IDfSysObject.setObjectName(java.lang.String objectName)
Sets the object_name attribute of the object.
|
void |
IDfAliasSet.setObjectName(java.lang.String objectName)
Sets the name of the alias set.
|
void |
IDfACL.setObjectName(java.lang.String name)
Sets the name of the ACL.
|
void |
IDfPlugin.setOperatingSystem(java.lang.String opSystem)
Sets the operating system of this plugin.
|
void |
IDfAssembly.setOrderNumber(double orderNumber)
Sets the order_no attribute of the assembly object.
|
void |
IDfRelation.setOrderNumber(int no)
Not system defined.
|
void |
IDfWorkitem.setOutput(IDfList list)
Sets the output ports.
|
void |
IDfWorkitem.setOutputByActivities(IDfList actList)
Defines the next activities to be assigned packages in the workflow.
|
void |
IDfVirtualDocumentNode.setOverrideLateBindingValue(boolean override)
Sets the use_node_ver_label attribute for the node's associated
containment object.
|
void |
IDfSysObject.setOwnerName(java.lang.String ownerName)
Sets the name of the object's owner.
|
void |
IDfGroup.setOwnerName(java.lang.String ownerName)
Sets the owner of this group.
|
void |
IDfAliasSet.setOwnerName(java.lang.String ownerName)
Sets the owner name of this alias set.
|
void |
IDfSysObject.setOwnerPermit(int permit)
Assigns the object-level permission to the owner of the object.
|
void |
IDfProcess.setPackageControl(int packageControl)
Sets the package_control attribute.
|
void |
IDfProcess.setPackageSchemaId(java.lang.String packageName,
IDfId schemaId)
Creates a relation between an XML schema document and a package.
|
void |
IDfProcess.setPackageSchemaUri(java.lang.String packageName,
java.lang.String schemaUri)
Creates a relation between an XML schema URI and a package.
|
void |
IDfWorkitem.setPackageSkillLevel(java.lang.String packageName,
int skillLevel)
Set the skill level of a given package.
|
void |
IDfWorkflow.setPackageSkillLevel(java.lang.String packageName,
int skillLevel)
Set the skill level of a given package.
|
void |
IDfAspectRelation.setParent(java.lang.String name)
Sets the parent aspect of an aspect relation object
|
void |
IDfWorkflow.setParentActName(java.lang.String actName)
Set parent_act_name attribute of the workflow
|
void |
IDfWorkflow.setParentActSeqno(int actSeqno)
Set parent_act_seqno attribute of the workflow
|
void |
IDfWorkflow.setParentId(IDfId parentId)
Set parent_id attribute of the workflow
|
void |
IDfRelation.setParentId(IDfId parent)
Sets the ID of the object that is the "parent" in the relationship.
|
void |
IDfAssembly.setParentId(IDfId parentObjectId)
Sets the parent_id attribute of the assembly object.
|
void |
IDfRelationType.setParentType(java.lang.String parent)
Sets the object type of a valid parent object in the
relationship.
|
void |
IDfPersistentObject.setPartition(int partition)
Set i_partition for this object.
|
void |
IDfSysObject.setPath(java.lang.String fileName,
java.lang.String formatName,
int pageNumber,
java.lang.String otherFile)
Sets the path to a content object or replaces an existing content.
|
void |
IDfLocation.setPathType(int pathType)
Sets the path type of this location.
|
void |
IDfProcess.setPerformerAliasId(IDfId aliasId)
Defines the process's performer alias set object id.
|
void |
IDfActivity.setPerformerFlag(int performerFlag)
Defines whether the activity's performer can delegate or extend the
activity.
|
void |
IDfActivity.setPerformerName(java.lang.String performerName)
Defines the user or group you want to perform the activity.
|
void |
IDfWorkitem.setPerformers(java.lang.String actName,
IDfList userGroupList)
Sets the performers attributes for the specified activity name.
|
void |
IDfWorkflow.setPerformers(java.lang.String actName,
IDfList userGroupList)
Sets the performers attributes for the specified activity name.
|
void |
IDfActivity.setPerformerType(int performerType)
Defines who can perform the activity.
|
void |
IDfRelationType.setPermanentLink(boolean val)
Indicates if you want to maintain the relationship across
versions of the parent object.
|
void |
IDfRelation.setPermanentLink(boolean val)
Deprecated.
As of DFC 5.3, replaced by IDfRelationType.setPermanentLink()
|
void |
IDfPlugin.setPluginType(java.lang.String type)
Sets the type of this plugin.
|
void |
IDfActivity.setPostTimer(int postTimer)
Defines the expected maximum number of hours to complete the activity.
|
void |
IDfActivity.setPostTimerRepeatLastAction(boolean repeatLast)
Sets an indicator for whether or not the final timer in a series should repeat.
|
void |
IDfLoadRecord.setPredicate(int index,
java.lang.String value) |
void |
IDfDumpRecord.setPredicate(int index,
java.lang.String value) |
void |
IDfDumpRecord.setPredicate2(int index,
java.lang.String value) |
void |
IDfActivity.setPreTimer(int preTimer)
Sets the pre-timer interval for the activity.
|
void |
IDfActivity.setPreTimerRepeatLastAction(boolean repeatLast)
Sets an indicator for whether or not the final timer in a series should repeat.
|
void |
IDfWorkitem.setPriority(int newPriority)
Sets the priority.
|
void |
IDfProcess.setPrivate(boolean isPrivate)
Defines whether the workflow definition is private or public.
|
void |
IDfGroup.setPrivate(boolean isPrivate)
Sets if this group is private or public
|
void |
IDfActivity.setPrivate(boolean isPrivate)
Defines the activity as public or private.
|
void |
IDfWorkflow.setProcessId(IDfId processId)
Sets the process ID for the workflow.
|
void |
IDfAuditTrailManager.setRegisterEvents(IDfId objectId,
IDfList events)
Sets a list of events for the object.
|
void |
IDfAspectRelation.setRelation(int type)
Sets the relation type of an aspect relation object.
|
void |
IDfRelationType.setRelationName(java.lang.String rName)
Sets the value of the relation_name attribute.
|
void |
IDfRelation.setRelationName(java.lang.String rName)
Sets the relation_name attribute.
|
void |
IDfLoadRecord.setRelocate(boolean value) |
void |
IDfRetainer.setRenditionRule(int renditionRule)
Sets the dm_retainer.rendition_rule value.
|
void |
IDfActivity.setRepeatableInvoke(boolean repeatableInvoke)
Defines whether the activity can be invoked multiple times when the
workflow is running.
|
void |
IDfTypedObject.setRepeatingBoolean(java.lang.String attributeName,
int valueIndex,
boolean value)
Sets a boolean value of a repeating attribute.
|
void |
IDfTypedObject.setRepeatingDouble(java.lang.String attributeName,
int valueIndex,
double value)
Sets a double value of a repeating attribute.
|
void |
IDfTypedObject.setRepeatingId(java.lang.String attributeName,
int valueIndex,
IDfId value)
Sets a Object ID value of a repeating attribute.
|
void |
IDfTypedObject.setRepeatingInt(java.lang.String attributeName,
int valueIndex,
int value)
Sets an integer value of a repeating attribute.
|
void |
IDfActivity.setRepeatingPerformerName(int index,
java.lang.String name)
Sets the performer name attribute at a specified index.
|
void |
IDfTypedObject.setRepeatingString(java.lang.String attributeName,
int valueIndex,
java.lang.String value)
Sets a string value of a repeating attribute.
|
void |
IDfTypedObject.setRepeatingTime(java.lang.String attributeName,
int valueIndex,
IDfTime value)
Sets a date/time value of a repeating attribute.
|
void |
IDfTypedObject.setRepeatingValue(java.lang.String attributeName,
int valueIndex,
IDfValue value)
Sets a value of a repeating attribute.
|
void |
IDfSysObject.setResolutionLabel(java.lang.String label)
Sets the resolution label for the object.
|
void |
IDfActivity.setResolvePackageName(java.lang.String resolvePkgName)
Sets the package name used to resolve performer aliasing.
|
void |
IDfActivity.setResolveType(int resolveType)
Sets the performer aliasing resolve type of the activity.
|
void |
IDfRetainer.setRetentionStorageClass(java.lang.String retentionStorageClass)
Sets the dm_retainer.retention_storage_class value.
|
void |
IDfPolicy.setReturnCondition(int index,
int value)
Set the attribute return_condition value at the specified index.
|
void |
IDfPolicy.setReturnToBase(int index,
boolean value)
Set the attribute return_to_base value at the specified index.
|
void |
IDfFormat.setRichmediaEnabled(boolean value) |
void |
IDfMethodObject.setRunAsServer(boolean value) |
void |
IDfMountPoint.setSecurityType(int securityType)
Sets the security type of this mount point.
|
void |
IDfLocation.setSecurityType(int securityType)
Sets the security type of this location.
|
void |
IDfRelationType.setSecurityType(java.lang.String sType)
Sets the security applied to objects of type dm_relation
whose relation_name attribute value matches the
relation_name attribute for the dm_relation_type object.
|
void |
IDfVirtualDocumentNode.setSelectedVersion(java.lang.String theVersion)
Overrides the node's binding criteria and displays the specified version.
|
void |
IDfSession.setServerTraceLevel(int level,
java.lang.String facility)
Sets the session's tracing level for a particular facility on the server.
|
void |
IDfTypedObject.setSessionManager(IDfSessionManager sessMgr)
Associates a session manager with this object.
|
void |
IDfActivity.setSignoffRequired(boolean signoffRequired)
Defines whether the activity requires a sign off.
|
void |
IDfSysObject.setSpecialApp(java.lang.String specialApp)
Reserved for use by Documentum products.
|
void |
IDfPolicy.setStateClass(int index,
int value)
Set the attribute state_class at the specified index.
|
void |
IDfPolicy.setStateDescription(int index,
java.lang.String value)
Set the attribute state_description value at the specified index.
|
void |
IDfPolicy.setStateName(int index,
java.lang.String value)
Set the attribute state_name value at the specified index.
|
void |
IDfStateExtension.setStateNo(int v)
Sets the number of the state that this object extends.
|
void |
IDfPolicy.setStateNo(int index,
int value)
Set the attribute i_state_no value at the specified index.
|
void |
IDfPolicy.setStateType(int index,
java.lang.String value)
Set the attribute state_type value at the specified index.
|
void |
IDfSysObject.setStatus(java.lang.String status)
Sets the a_status attribute of the object.
|
void |
IDfSysObject.setStorageType(java.lang.String type)
Sets the storage area for content files associated with the object.
|
void |
IDfSysObjectStream.setStream(java.io.InputStream stream,
int size,
java.lang.String format)
Sets content as input stream to an associated sysobject.
|
void |
IDfSysObjectStream.setStreamEx(java.io.InputStream stream,
long size,
java.lang.String format,
int page,
java.io.InputStream otherStream,
long otherSize)
This is the extended setStream() method for setting the content as InputStream to an associated sysobject.
|
void |
IDfTypedObject.setString(java.lang.String attributeName,
java.lang.String value)
Sets the string value of an attribute.
|
void |
IDfSysObject.setStringContentAttribute(java.lang.String name,
java.lang.String value,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Set a String content attribute.
|
void |
IDfSysObject.setSubject(java.lang.String subject)
Sets the subject attribute of the object.
|
void |
IDfMethodObject.setSuccessReturnCodes(int index,
int value) |
void |
IDfMethodObject.setSuccessStatus(java.lang.String value) |
void |
IDfWorkflow.setSupervisorName(java.lang.String supervisorName)
Sets the name of the workflow supervisor.
|
void |
IDfPolicy.setSystemActions(int index,
IDfId value)
Set the attribute system_actions value at the specified index.
|
void |
IDfActivity.setTaskSubject(java.lang.String name)
Set a subject for the task inbox item, the subject will be constructed at
the creation time of the inbox item
|
void |
IDfTypedObject.setTime(java.lang.String attributeName,
IDfTime value)
Sets the date/time value of an attribute.
|
void |
IDfSysObject.setTimeContentAttribute(java.lang.String name,
IDfTime value,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Set a Date/Time content attribute.
|
void |
IDfMethodObject.setTimeoutDefault(int value) |
void |
IDfMethodObject.setTimeoutMax(int value) |
void |
IDfMethodObject.setTimeoutMin(int value) |
void |
IDfSessionManagerConfig.setTimeZone(java.lang.String value) |
void |
IDfSysObject.setTitle(java.lang.String title)
Sets the title attribute of the object.
|
void |
IDfFormat.setTopicFilter(java.lang.String value) |
void |
IDfFormat.setTopicFormat(IDfId value) |
void |
IDfFormat.setTopicFormatName(java.lang.String value) |
void |
IDfFormat.setTopicTransform(boolean value) |
void |
IDfMethodObject.setTraceLaunch(boolean value) |
void |
IDfActivity.setTransitionEvalCount(int count)
Set the number of completed tasks that are required to trigger
the next activities.
|
void |
IDfActivity.setTransitionFlag(int flag)
Together with the transition eval count, set when and how to trigger
the selected outgoing paths when activity is manual transition
|
void |
IDfActivity.setTransitionMaxOutputCount(int count)
Set the maximum number of output ports user can select at runtime
when activity is manual transition
|
void |
IDfActivity.setTransitionType(int transitionType)
Defines the transition type for the activity.
|
void |
IDfActivity.setTriggerEvent(java.lang.String triggerEvent)
Sets the event type that is expected to trigger the activity.
|
void |
IDfActivity.setTriggerThreshold(int triggerThreshold)
Defines the trigger threshold for the activity.
|
void |
IDfPolicy.setTypeOverrideId(int index,
IDfId value)
Set the attribute type_override_id value at the specified index.
|
void |
IDfMountPoint.setUnixPreferredAlias(java.lang.String alias)
Sets the UNIX preferred alias of this mount point.
|
void |
IDfPlugin.setUsage(java.lang.String usage)
Sets the usage of this plugin.
|
void |
IDfMethodObject.setUseMethodContent(boolean value) |
void |
IDfMethodObject.setUseMethodServer(boolean value) |
void |
IDfPolicy.setUserActionId(int index,
IDfId value)
Set the attribute user_action_id value at the specified index.
|
void |
IDfPolicy.setUserActionService(int index,
java.lang.String value)
Set the attribute user_action_service value at the specified index.
|
void |
IDfPolicy.setUserActionVer(int index,
java.lang.String value)
Set the attribute user_action_ver value at the specified index.
|
void |
IDfUser.setUserAddress(java.lang.String userAddress)
Sets the user's email address.
|
void |
IDfPolicy.setUserCriteriaId(int index,
IDfId value)
Set the attribute user_criteria_id value at the specified index.
|
void |
IDfPolicy.setUserCriteriaService(int index,
java.lang.String value)
Set the attribute user_criteria_service value at the specified index.
|
void |
IDfPolicy.setUserCriteriaVer(int index,
java.lang.String value)
Set the attribute user_criteria_ver value at the specified index.
|
void |
IDfUser.setUserDBName(java.lang.String userDBName)
Sets this user's RDBMS user name.
|
void |
IDfUser.setUserDelegation(java.lang.String delegateUserName)
Sets the name of the user to whom to delegate work items.
|
void |
IDfUser.setUserGroupName(java.lang.String userGroupName)
Sets this user's default group.
|
void |
IDfUser.setUserLoginName(java.lang.String userLoginName)
Sets the user's Documentum user login name To change the user login name of an existing user.
|
void |
IDfUser.setUserName(java.lang.String userName)
Sets the name of this user.
|
void |
IDfUser.setUserOSName(java.lang.String accountName,
java.lang.String domainName)
Sets this user's authentication information: operating system account name and domain.
|
void |
IDfUser.setUserPassword(java.lang.String value)
Sets the user password for inline users.
|
void |
IDfPolicy.setUserPostprocessingService(int index,
java.lang.String value)
Set the attribute user_post_processing_service value at the specified index.
|
void |
IDfPolicy.setUserPostprocId(int index,
IDfId value)
Set the attribute user_postproc_id value at the specified index.
|
void |
IDfPolicy.setUserPostprocVer(int index,
java.lang.String value)
Set the attribute user_postproc_ver at the specified index.
|
void |
IDfUser.setUserPrivileges(int userPrivileges)
Sets this user's privileges level.
|
void |
IDfUser.setUserSource(int userSource)
Deprecated.
As of DFC 5.2.5, replaced by setUserSourceAsString(String)
|
void |
IDfUser.setUserSourceAsString(java.lang.String userSource)
Sets this user's source.
|
void |
IDfUser.setUserState(int userState,
boolean unlockObjects)
Sets this user's activation state (active/inactive).
|
void |
IDfPolicy.setUserValidationService(java.lang.String value)
Set the attribute user_validation_service value for this policy.
|
void |
IDfUser.setUserXPrivileges(int userXPrivileges)
Sets the user's extended privileges.
|
void |
IDfLocation.setValidate(boolean validate)
Sets whether this location should validate
|
void |
IDfTypedObject.setValue(java.lang.String attributeName,
IDfValue value)
Sets the value of an attribute.
|
void |
IDfFormat.setWin31App(java.lang.String value) |
void |
IDfMountPoint.setWinPreferredAlias(java.lang.String alias)
Sets the Windows preferred alias of this mount point.
|
void |
IDfUser.setWorkflowDisabled(boolean disabled)
Sets whether this user is workflow disabled.
|
void |
IDfSysObject.setWorldPermit(int permit)
Sets the object-level permission assigned to the world for the object.
|
void |
IDfUser.setWriteFederationLogOption(int options)
Sets the options on various properties to write to the federation log when properties are changed.
|
void |
IDfSession.shutdown(boolean immediate,
boolean deleteEntry)
Shuts down a server.
|
void |
IDfPersistentObject.signoff(java.lang.String user,
java.lang.String os_password,
java.lang.String reason)
Creates an audit trail entry of signoff information for an object.
|
void |
IDfRouter.signOffRouter(int taskNumber,
java.lang.String userOSName,
java.lang.String password)
Deprecated.
|
void |
IDfRouter.start(java.lang.String message)
Deprecated.
|
IDfCollection |
IDfSession.startGatheringMetrics(java.util.List<java.lang.String> metricsToGather)
This methods indicates to the server to start gathering the metrics that have been passed in
to this method.
|
IDfId |
IDfWorkflowBuilder.startWorkflow()
Deprecated.
|
IDfCollection |
IDfSession.stopGatheringMetrics(java.util.List<java.lang.String> metricsToStop)
This methods indicates to the server to stop gathering the metrics that have been passed in
to this method.
|
void |
IDfSysObject.suspend(java.lang.String state,
boolean override,
boolean fTestOnly)
Suspends the sysobject from its current state to the exception
state.
|
void |
IDfSysObjectRetention.swapRetainer(IDfId oldRetainerId,
IDfId newRetainerId)
Replace a dm_retainer attached to the object to a new one.
|
boolean |
IDfPredicate.test(java.lang.Object state)
Evaluates a boolean condition given some runtime state.
|
void |
IDfSession.traceDMCL(int level,
java.lang.String traceFile)
Deprecated.
Please configure tracing using the ClientConfig object
IDfClient.getClientConfig() |
void |
IDfSysObjectRetention.triggerConditionalRetention()
Function triggers the clip inside Centera associated with the SysObject object.
|
void |
IDfTypedObject.truncate(java.lang.String attributeName,
int valueIndex)
Truncates the values stored in a repeating attribute.
|
void |
IDfClient.unadoptDMCLSession(java.lang.String dmclSessionId)
Deprecated.
session adoption is no longer useful without a separate DMCL
|
void |
DfClient.unadoptDMCLSession(java.lang.String dmclSessionId) |
void |
IDfSysObject.unfreeze(boolean thawComponents)
Unfreezes a frozen object, and optionally if the object is a
virtual document, it unfreezes the object's associated assembly.
|
void |
IDfProcess.uninstall()
Moves the installed workflow definition back to the validated state.
|
void |
IDfActivity.uninstall()
Uninstalls an activity.
|
void |
IDfPolicy.unInstall(boolean notify)
Validate this policy.
|
void |
IDfSysObject.unlink(java.lang.String folderSpec)
Removes a link between the object and a folder or cabinet.
|
void |
IDfSysObject.unmark(java.lang.String versionLabels)
Removes symbolic labels from an object.
|
void |
IDfAuditTrailManager.unregisterAllEvents(IDfId objectId)
Unregisters all events for the object.
|
void |
IDfAuditTrailManager.unregisterEvent(IDfId objectId,
java.lang.String event)
Unregisters an event for the object.
|
void |
IDfPersistentObject.unRegisterEvent(java.lang.String event)
Removes the current user's registration for a specified event.
|
void |
IDfPersistentObject.unRegisterEventEx(java.lang.String event,
java.lang.String userName)
Removes the current user's registration for a specified event.
|
void |
IDfAuditTrailManager.unregisterEventForObject(IDfId objectId,
java.lang.String event,
IDfId policyId,
java.lang.String stateName)
Unregisters an event for the object type.
|
void |
IDfAuditTrailManager.unregisterEventForType(java.lang.String typeName,
java.lang.String event,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName)
Unregisters an event for the object type.
|
void |
IDfAuditTrailManager.unregisterEvents(IDfId objectId,
IDfList events)
Unregisters a list of events for the object.
|
void |
IDfAuditTrailManager.unregisterEventsFromQuery(java.lang.String query,
IDfList events)
For each object returned by the query, removes the registrations for the specified events.
|
void |
IDfAuditTrailManager.unregisterEventsInFolder(IDfId folderId,
IDfList events)
Unregisters a list of events for all sysobjects under the folder.
|
void |
IDfSysObject.updatePart(IDfId containmentId,
java.lang.String versionLabel,
double orderNumber,
boolean useNodeVerLabel,
boolean followAssembly,
int copyChild)
Modifies a child dmr_containment attribute value.
|
void |
IDfSysObject.updatePartEx(IDfId containmentId,
java.lang.String versionLabel,
double orderNumber,
boolean useNodeVerLabel,
boolean followAssembly,
int copyChild,
java.lang.String containType,
java.lang.String containDesc) |
void |
IDfWorkflow.updateSupervisorName(java.lang.String supervisorName)
Change the supervisor of a running workflow.
|
void |
IDfSysObject.useACL(java.lang.String aclType)
Assigns an ACL specification to the object.
|
void |
IDfProcess.validate()
Validates the workflow definition.
|
void |
IDfPolicy.validate()
Validate this policy.
|
void |
IDfActivity.validate()
Validates the package definitions associated with the activity.
|
void |
IDfValidator.validateAll(IDfProperties attrValues,
boolean modifiedAttrsOnly)
Performs both attribute level and object level validation.
|
void |
IDfValidator.validateAllAttrRules(IDfProperties attrValues,
boolean modifiedAttrsOnly)
Validate the user input
attrValues with all the attribute level
validation rules specified for this object type, policy and state
set in the Data Dictionary. |
void |
IDfValidator.validateAllObjRules(IDfProperties attrValues)
Validate the user input attrValues with all the object level
validation rules specified for this object type, policy and state
set in the Data Dictionary.
|
void |
IDfPersistentObject.validateAllRules(int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAll on IDfValidator instead
|
void |
IDfValidator.validateAttrRules(java.lang.String attrName,
IDfList values,
IDfProperties depAttrValues)
Validate the specified attribute with the validation rules set in
the Data Dictionary given a list of attribute values, and an IDfProperties
interface containing dependent attributes.
|
void |
IDfPersistentObject.validateAttrRules(java.lang.String attrName,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAttrRules on IDfValidator instead
|
void |
IDfPersistentObject.validateAttrRulesWithValue(java.lang.String attrName,
java.lang.String value,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAttrRules on IDfValidator instead
|
void |
IDfPersistentObject.validateAttrRulesWithValues(java.lang.String attrName,
IDfList valueList,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAttrRules on IDfValidator instead
|
void |
IDfProcess.validateEx(boolean checkActivity)
Validates the workflow definition.
|
void |
IDfPersistentObject.validateObjRules(int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAllObjRules on IDfValidator instead
|
void |
IDfPersistentObject.validateObjRulesWithValues(IDfList attrNameList,
IDfList valueListList,
int stopAfterNumOfErrors)
Deprecated.
use getValidator and then call validateAllObjRules on IDfValidator instead
|
void |
IDfProcess.validateProcessAndActivities()
Validates the workflow defintion and its referenced activities.
|
void |
IDfRouter.validateRouter(boolean externalApps)
Deprecated.
|
void |
IDfType.validateTypeAttrRulesWithValue(java.lang.String attrName,
IDfId policyId,
java.lang.String state,
java.lang.String value,
IDfList depAttrNameList,
IDfList depAttrValueListList,
int stopAfterNumOfErrors)
Deprecated.
|
void |
IDfType.validateTypeAttrRulesWithValues(java.lang.String attrName,
IDfId policyId,
java.lang.String state,
IDfList values,
IDfList depAttrNameList,
IDfList depAttrValueListList,
int stopAfterNumOfErrors)
Deprecated.
|
void |
IDfType.validateTypeObjRulesWithValues(IDfList attrNameList,
IDfId policyId,
java.lang.String state,
IDfList valueListList,
int stopAfterNumOfErrors)
Deprecated.
|
boolean |
IDfAuditTrail.verifyAudit()
This API verifies this particular Audit Trail object and returns true or false accordingly.
|
void |
IDfSysObject.verifyESignature()
Verify the signature on an electronically signed sysobject.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfBocsConfig.addExternalUrlEntry(IDfBocsConfig.ExternalUrlEntry urlEntry)
Adds ExternalUrlEntry object.
|
void |
IDfAcsConfig.addProjectionEntry(IDfAcsConfig.ProjectionEntry projectionEntry)
Adds ProjectionEntry object.
|
void |
IDfAcsConfig.addStoreEntry(IDfAcsConfig.StoreEntry storeEntry)
Adds StoreEntry object.
|
void |
IDfAcsClient.addUnavailableAcsServer(java.lang.String urlString)
Add the specified accelerated content store (ACS) server
to the list of unavailable ACS servers.
|
void |
IDfAcsConfig.addUrlEntry(IDfAcsConfig.UrlEntry urlEntry)
Adds UrlEntry object.
|
void |
IDfBocsConfig.addUrlEntry(IDfBocsConfig.UrlEntry urlEntry)
Adds UrlEntry object.
|
IDfEnumeration |
IDfAcsClient.getAcsData(IDfSessionManager sessionManager,
java.lang.String docbaseName,
java.lang.String networkLocationIdentifier)
Returns an
IDfEnumeration object that lists all
AcsData objects for a given repository. |
IDfEnumeration |
IDfAcsClient.getAcsData(IDfSession session,
java.lang.String networkLocationIdentifier)
Returns an
IDfEnumeration object that lists all
AcsData objects for a given repository. |
IDfList |
IDfAcsConfig.getAcsNetworkLocationIdentifiers()
Returns a list of the ACS network location identifiers.
|
IDfEnumeration |
IDfAcsClient.getAllNetworkLocations(java.lang.String locale)
Returns an
IDfEnumeration object that lists all IDfNetworkLocationEntry objects. |
java.lang.String |
IDfContentTransferConfig.getBocsEncryptionMode()
Returns BOCS encryption mode in this repository.
|
IDfEnumeration |
IDfAcsClient.getClientNetworkLocations(java.lang.String clientIPAddress,
java.lang.String locale)
Returns an
IDfEnumeration object that lists all IDfNetworkLocationEntry objects. |
int |
IDfAcsConfig.getConfigType()
Returns type of the config.
0 - no projections, i.e.
|
java.lang.String |
IDfBocsConfig.getDeliveryType()
Returns the delivery type
|
java.lang.String |
IDfValidationDescriptor.getDescriptorVersion()
Returns the descriptor version as major.minor
|
IDfList |
IDfBocsConfig.getDocbaseNames()
Returns list of the repository names.
|
java.lang.String |
IDfAcsConfig.getDormancyStatus()
Gets the dormancy status for this ACS
|
java.lang.String |
IDfContentTransferConfig.getEffectiveBocsEncryptionMode()
Returns BOCS encryption mode in this repository.
|
IDfList |
IDfBocsConfig.getExternalUrlEntries()
Returns list of ExternalUrlEntry objects.
|
java.lang.String |
IDfDmsConfig.getMessageConsumeUrl()
Returns URL that can be used by agents to consume messages from DMS in a pull mode
|
java.lang.String |
IDfDmsConfig.getMessagePostUrl()
Returns URL that can be used to post messages to DMS
|
IDfList |
IDfAcsConfig.getNearStores()
Returns list of names of stores that are near the ACS.
|
IDfNetworkLocationEntry |
IDfAcsClient.getNetworkLocation(java.lang.String locationId,
java.lang.String locale)
Returns an
IDfNetworkLocationEntry object by location identifier. |
IDfList |
IDfBocsConfig.getNetworkLocationIdentifiers()
Returns list of the BOCS network location identifiers.
|
java.lang.String |
IDfValidationDescriptor.getObjectName()
Returns the descriptor name.
|
java.lang.String |
IDfBocsConfig.getObjectName()
Returns the BOCS name.
|
java.lang.String |
IDfAcsConfig.getObjectName()
Returns the ACS name.
|
IDfList |
IDfValidationDescriptor.getParameterNames()
Returns the list of parameter names
|
IDfList |
IDfAcsConfig.getProjectionEntries()
Returns list of ProjectionEntry objects.
|
int |
IDfAcsConfig.getRWCapability()
Deprecated.
use isEnabled and isSurrogateGetEnabled methods
|
IDfId |
IDfAcsConfig.getServerConfigId()
Returns the ID of the Content Server config object for the ACS.
|
java.lang.String |
IDfDmsConfig.getServerMajorVersion()
Returns server major version
|
java.lang.String |
IDfBocsConfig.getServerMajorVersion()
Returns server major version
|
java.lang.String |
IDfAcsConfig.getServerMajorVersion()
Returns server major version
|
java.lang.String |
IDfDmsConfig.getServerMinorVersion()
Returns the server minor version
|
java.lang.String |
IDfBocsConfig.getServerMinorVersion()
Returns the server minor version
|
java.lang.String |
IDfAcsConfig.getServerMinorVersion()
Returns the server minor version
|
IDfList |
IDfAcsConfig.getStoreEntries()
Returns list of StoreEntry objects.
|
IDfList |
IDfBocsConfig.getUrlEntries()
Returns list of UrlEntry objects.
|
IDfList |
IDfAcsConfig.getUrlEntries()
Returns list of UrlEntry objects.
|
boolean |
IDfContentTransferConfig.isAcsAsynchWriteEnabled()
Returns whether ACS asynchronous write mode is enabled in this repository.
|
boolean |
IDfContentTransferConfig.isAcsReadEnabled()
Returns whether ACS read mode is enabled in this repository.
|
boolean |
IDfContentTransferConfig.isAcsWriteEnabled()
Returns whether ACS write mode is enabled in this repository.
|
boolean |
IDfBocsConfig.isAsynchWriteEnabled()
Returns a flag indicating whether asynchronous write is enabled
|
boolean |
IDfContentTransferConfig.isBocsPrecachingEnabled()
Returns whether BOCS predictive caching is enabled in this repository.
|
boolean |
IDfAcsConfig.isCacheAcs()
Deprecated.
as of version D6,
use
IDfBocsConfig for cache server config objects. |
boolean |
IDfAcsClient.isContentTransferCapabilityEnabled(IDfSession session,
java.lang.String networkLocationIdentifier,
IDfContentTransferCapability capability)
Returns whether content transfer capability is enabled in a docbase
of a given session.
|
boolean |
IDfDmsConfig.isEnabled()
Returns whether DMS is enabled.
|
boolean |
IDfBocsConfig.isEnabled()
Returns a flag indicating whether BOCS is enabled
|
boolean |
IDfAcsConfig.isEnabled()
Returns a flag indicating whether ACS is enabled
|
boolean |
IDfBocsConfig.isInclusionList()
Returns a flag indicating whether the list of repositories is an inclusion list.
|
boolean |
IDfAcsConfig.isSurrogateGetEnabled()
Returns a flag indicating whether both read and a "surrogate get" is enabled
|
IDfBocsConfig.ExternalUrlEntry |
IDfBocsConfig.newExternalUrlEntry(java.lang.String url,
java.lang.String type)
Creates ExternalUrlEntry object.
|
IDfAcsConfig.ProjectionEntry |
IDfAcsConfig.newProjectionEntry(java.lang.String networkLocationIdentifier,
int proximity)
Creates ProjectionEntry object.
|
IDfAcsConfig.ProjectionEntry |
IDfAcsConfig.newProjectionEntry(java.lang.String host,
int port,
int proximity)
Creates ProjectionEntry object.
|
IDfAcsConfig.ProjectionEntry |
IDfAcsConfig.newProjectionEntry(java.lang.String host,
int port,
int proximity,
boolean isEnabled,
java.lang.String networkLocationIdentifier,
boolean isNetworkLocationEnabled)
Creates ProjectionEntry object.
|
IDfAcsConfig.StoreEntry |
IDfAcsConfig.newStoreEntry(int storeType,
int cryptoMode,
int compressionMode)
Creates StoreEntry object.
|
IDfBocsConfig.UrlEntry |
IDfBocsConfig.newUrlEntry(java.lang.String url,
java.lang.String protocol)
Creates UrlEntry object.
|
IDfAcsConfig.UrlEntry |
IDfAcsConfig.newUrlEntry(java.lang.String url,
java.lang.String protocol)
Creates UrlEntry object.
|
void |
IDfAcsConfig.setAcsNetworkLocationIdentifiers(IDfList acsNetworkLocationIdentifiers)
Sets the ACS network location identifiers.
|
void |
IDfContentTransferConfig.setAcsReadEnabled(boolean isEnabled)
Sets whether ACS read mode is enabled in this repository.
|
void |
IDfContentTransferConfig.setAcsWriteMode(java.lang.String mode)
Sets ACS write mode in this repository.
|
void |
IDfBocsConfig.setAsynchWriteEnabled(boolean isEnabled)
Sets a flag indicating whether asynchronous write is enabled.
|
void |
IDfContentTransferConfig.setBocsEncryptionMode(java.lang.String mode)
Sets BOCS encryption mode in this repository.
|
void |
IDfContentTransferConfig.setBocsPrecachingEnabled(boolean isEnabled)
Sets whether BOCS predictive caching is enabled in this repository.
|
void |
IDfAcsConfig.setCacheAcs(boolean isCacheAcs)
Deprecated.
as of version D6,
use
IDfBocsConfig for cache server config objects. |
void |
IDfAcsConfig.setConfigType(int configType)
Sets type of the config.
|
void |
IDfBocsConfig.setDeliveryType(java.lang.String deliveryType)
Sets the delivery type
|
void |
IDfValidationDescriptor.setDescriptorVersion(java.lang.String version)
Sets the descriptor version
|
void |
IDfBocsConfig.setDocbaseNames(IDfList docbaseNames)
Sets the repository names.
|
void |
IDfDmsConfig.setEnabled(boolean isEnabled)
Sets whether DMS is enabled.
|
void |
IDfBocsConfig.setEnabled(boolean isEnabled)
Sets a flag indicating whether BOCS is enabled
|
void |
IDfAcsConfig.setEnabled(boolean isEnabled)
Sets a flag indicating whether ACS is enabled
|
void |
IDfBocsConfig.setExternalUrlEntries(IDfList urlEntries)
Replace all ExternalUrlEntry objects.
|
void |
IDfBocsConfig.setInclusionList(boolean isInclusionList)
Sets a flag indicating whether the list of repositories is an inclusion list.
|
void |
IDfDmsConfig.setMessageConsumeUrl(java.lang.String url)
Sets URL that can be used by agents to consume messages from DMS in a pull mode
|
void |
IDfDmsConfig.setMessagePostUrl(java.lang.String url)
Sets URL that can be used to post messages to DMS
|
void |
IDfAcsConfig.setNearStores(IDfList nearStores)
Sets list of names of stores that are near the ACS.
|
void |
IDfBocsConfig.setNetworkLocationIdentifiers(IDfList networkLocationIdentifiers)
Sets the BOCS network location identifiers.
|
void |
IDfValidationDescriptor.setObjectName(java.lang.String descriptorName)
Sets the descriptor name.
|
void |
IDfBocsConfig.setObjectName(java.lang.String objectName)
Sets the BOCS name.
|
void |
IDfAcsConfig.setObjectName(java.lang.String objectName)
Sets the ACS name.
|
void |
IDfValidationDescriptor.setParameterNames(IDfList parameterNames)
Sets the list of parameter names
|
void |
IDfAcsConfig.setProjectionEntries(IDfList projectionEntries)
Replace all ProjectionEntry objects.
|
void |
IDfAcsConfig.setRWCapability(int capability)
Deprecated.
use setEnabled and setSurrogateGetEnabled methods
|
void |
IDfAcsConfig.setServerConfigId(IDfId serverConfigId)
Sets the ID of the Content Server config object for the ACS.
|
void |
IDfDmsConfig.setServerMajorVersion(java.lang.String majorVersion)
Sets server major version
|
void |
IDfBocsConfig.setServerMajorVersion(java.lang.String majorVersion)
Sets server major version
|
void |
IDfAcsConfig.setServerMajorVersion(java.lang.String majorVersion)
Sets server major version
|
void |
IDfDmsConfig.setServerMinorVersion(java.lang.String minorVersion)
Sets the server minor version
|
void |
IDfBocsConfig.setServerMinorVersion(java.lang.String minorVersion)
Sets the server minor version
|
void |
IDfAcsConfig.setServerMinorVersion(java.lang.String minorVersion)
Sets the server minor version
|
void |
IDfAcsConfig.setStoreEntries(IDfList storeEntries)
Replaces all StoreEntry objects.
|
void |
IDfAcsConfig.setSurrogateGetEnabled(boolean isEnabled)
Sets a flag indicating whether both read and a "surrogate get" is enabled.
|
void |
IDfBocsConfig.setUrlEntries(IDfList urlEntries)
Replace all UrlEntry objects.
|
void |
IDfAcsConfig.setUrlEntries(IDfList urlEntries)
Replaces all UrlEntry objects.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfAspects.attachAspect(java.lang.String name,
IDfAttachAspectCallback callback)
Attaches the named aspect and invokes the optional callback when the object is completely rebuilt.
|
void |
IDfAspects.detachAspect(java.lang.String name,
IDfDetachAspectCallback callback)
Detaches the named aspect and invokes the optional callback when the object is completely rebuilt.
|
IDfList |
IDfAspects.getAspects()
Returns a list of the names of all attached aspects.
|
Modifier and Type | Class and Description |
---|---|
class |
DfContentTemporarilyUnavailableException
This exception is thrown when content has not been stored in a docbase yet.
|
Modifier and Type | Method and Description |
---|---|
boolean |
IDfFtConfig.isCapabilitySupported(IDfFtConfig.FtCapability capability)
Checks if the given capability is supported by the underlying fulltext
engine.
|
Modifier and Type | Class and Description |
---|---|
class |
DfConfigurationException
This exception is thrown in case of a possible configuration issue of the ECIS adpaters when doing a search.
|
class |
DfQueryFormatException
This exception is thrown when format of a stored query cannot be recognized.
|
class |
DfQueryGenerationException
This exception is thrown when unexpected condition is discovered during query generation process.
|
class |
DfResultContentException
This exception is thrown during the retrieval of a result content.
|
class |
DfSearchException
This exception is a base exception for the
com.documentum.fc.client.search package. |
class |
DfSearchLoginException
This exception is thrown when credentials are invalid.
|
class |
DfUnreachableLocationException
This exception is thrown when the target location is unreachable.
|
Modifier and Type | Method and Description |
---|---|
DfException |
IDfQueryEvent.getException()
In case of an error, this method may return the actual exception that occurs with the source.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfExpression.acceptVisitor(DfExpressionVisitor visitor)
Visits this expression.
|
IDfLocationQueryScope |
IDfQueryBuilder.addLocationScope(java.lang.String source,
IDfId locationId,
boolean isDescend,
boolean isExcluded)
Adds a location scope.
|
IDfLocationQueryScope |
IDfQueryBuilder.addLocationScope(java.lang.String source,
java.lang.String locationPath,
boolean isDescend)
Adds a location scope.
|
IDfLocationQueryScope |
IDfQueryBuilder.addLocationScope(java.lang.String source,
java.lang.String locationPath,
boolean isDescend,
boolean isExcluded)
Adds a location scope.
|
IDfPartitionScope |
IDfQueryBuilder.addPartitionScope(java.lang.String source,
java.lang.String partitionName)
Adds a partition scope.
|
void |
IDfSearchSourceContainer.addSelectedSource(java.lang.String sourceName)
Adds a selected source.
|
boolean |
IDfSmartList.areResultsSaved()
Checks whether results are saved or not with the search.
|
void |
IDfSearchSourceContainer.clearSelectedSources()
Removes all selected sources.
|
java.lang.String |
IDfSearchMetadataManager.convertDocbaseToMimeFormat(java.lang.String docbaseFormat)
Converts a repository format value to MIME format value.
|
java.lang.String |
IDfSearchMetadataManager.convertMimeToDocbaseFormat(java.lang.String mimeFormat)
Converts a MIME format value to repository format value.
|
IDfSmartListDefinition |
IDfQueryManager.convertSmartListDefinition(IDfSysObject oldSmartList)
Converts smart list definition using a legacy dm_smartlist object.
|
IDfSmartListDefinition |
IDfSmartListDefinition.copy()
Performs a deep copy of this instance.
|
IDfSmartList |
IDfSearchStoreService.createSearch(java.lang.String name,
java.lang.String description,
IDfSmartListDefinition smartListDefinition,
IDfResultsSet resultSet,
IDfQueryStatus queryStatus)
Creates a new search prior to storing it.
|
boolean |
IDfSearchStoreService.existsSearch(java.lang.String objectName,
boolean inMySearches,
java.lang.String folderId)
Checks whether a search with the same name already
exists in the database.
|
IDfCollection |
IDfSearchStoreService.getAllSearches()
Deprecated.
Use getAllSearches(IDfSession) instead
|
IDfCollection |
IDfSearchStoreService.getAllSearches(IDfSession session)
Returns all searches from this repository, including
all of the user's searches and any shared searches.
|
IDfPersistentObject |
IDfResultObjectManager.getAsPersistentObject(IDfResultEntry entry)
Gets the IDfTypedObject corresponding to the result.
|
int |
IDfSearchTypeAssistant.getAttrDataType(java.lang.String attrName)
Retrieves the datatype of an attribute.
|
java.lang.String |
IDfSearchTypeAssistant.getAttributeLabel(java.lang.String attrName)
Retrieves a localized attribute label for a given attribute.
|
IDfEnumeration |
IDfSearchTypeAssistant.getAttributeNames()
Retrieves an enumeration of the names of the searchable attributes for the type.
|
int |
IDfSearchSourceMap.getAvailableSourceCount()
Gets the count of available sources.
|
IDfEnumeration |
IDfSearchSourceMap.getAvailableSources()
Provides access to an enumeration of all available sources.
|
IDfEnumeration |
IDfSearchSourceMap.getAvailableSources(int sourceType)
Provides access to an enumeration of available sources of a given type.
|
IDfEnumeration |
IDfSearchMetadataManager.getAvailableTypes()
Provides an enumeration of available searchable types.
|
IDfEnumeration |
IDfSearchMetadataManager.getAvailableTypes(boolean includeObsoleteTypes)
Provides an enumeration of available searchable types derived from a specified base type.
|
IDfEnumeration |
IDfSearchMetadataManager.getAvailableTypes(java.lang.String baseType)
Provides an enumeration available types derived from a specified base type.
|
IDfEnumeration |
IDfSearchMetadataManager.getAvailableTypes(java.lang.String baseType,
boolean includeObsoleteTypes)
Provides an enumeration available types derived from a specified base type.
|
IDfResultContent |
IDfResultObjectManager.getContent(IDfResultEntry entry)
Gets the content corresponding to the result.
|
java.lang.String |
IDfModifiableResultEntry.getContentDescriptor()
Gets the descriptor of an external result content.
|
IDfCollection |
IDfSearchStoreService.getCurrentUserSearches()
Deprecated.
Use getCurrentUserSearches(IDfSession) instead
|
IDfCollection |
IDfSearchStoreService.getCurrentUserSearches(IDfSession session)
Returns only the user's searches from this repository.
|
java.lang.String |
IDfSearchTypeAssistant.getDefaultAttribute()
Provides access to a default attribute for the type.
|
java.lang.String |
IDfSearchTypeAssistant.getDefaultSearchOp(java.lang.String attrName)
Retrieves the default search operation as a string code (such as "10", "1", ...) for an attribute.
|
java.lang.String |
IDfSearchTypeAssistant.getDefaultValue(java.lang.String attrName)
Retrieves the default search value for the specified attribute.
|
java.lang.String |
IDfSearchTypeAssistant.getDefaultValue(java.lang.String attrName,
java.lang.String searchOp)
Deprecated.
|
java.lang.String |
IDfResultContent.getDOSExtension()
Gets the default DOS extension corresponding to the content type.
|
IDfList |
IDfSearchMetadataManager.getDOSExtensions(java.lang.String mimeFormat)
Gets the DOS extensions associated to the specified MIME format value in the repository.
|
java.io.InputStream |
IDfResultContent.getInputStream()
Gets an InputStream to the content.
|
IDfObjectPath |
IDfLocationQueryScope.getLocationPath()
Gets the location path.
|
java.lang.String |
IDfSearchMetadataManager.getMetadataDocbase()
Gets the repository to pick the metadata information from information on types.
|
java.lang.String |
IDfResultContent.getMIMEType()
Gets the MIME type of the content.
|
IDfId |
IDfResultObjectManager.getObjectId(IDfResultEntry entry)
Gets the object ID of the object corresponding to the result.
|
java.lang.String |
IDfSmartList.getQueryDefinitionType()
Gets the Query definition type.
|
IDfQueryStatus |
IDfSmartList.getQueryStatus()
Gets the IDfQueryStatus.
|
IDfResultEntry |
IDfResultsSet.getResultByKey(java.lang.String key)
Gets the result that is represented by the specified String key.
|
int |
IDfSmartList.getResultsCount()
Gets the number of results for the search.
|
IDfResultsSet |
IDfSmartList.getResultsSet()
Gets the IDfResultsSet.
|
java.lang.String |
IDfSearchTypeAssistant.getSearchOpLabel(java.lang.String attrName,
java.lang.String searchOp)
Retrieves a localized search operation label (such as "Greater than", "Equal", ...) for a given search operation
code.
|
IDfEnumeration |
IDfSearchTypeAssistant.getSearchOpLabels(java.lang.String attrName)
Retrieves an enumeration of the localized search operation labels (such as "Greater than", "Equal", ...).
|
IDfEnumeration |
IDfSearchTypeAssistant.getSearchOps(java.lang.String attrName)
Retrieves an enumeration of search operations as string codes (such as "10", "1", ...).
|
int |
IDfResultContent.getSize()
Gets the size of the content.
|
IDfSmartListDefinition |
IDfSmartList.getSmartListDefinition(IDfSearchService searchService)
Gets the IDfSmartListDefinition associated to this dm_smart_list.
|
IDfSearchSource |
IDfSearchSourceMap.getSource(java.lang.String sourceName)
Provides access to an individual source.
|
java.lang.String |
IDfSearchTypeAssistant.getSuperName()
Gets the super-type name.
|
IDfType |
IDfSearchTypeAssistant.getType()
Returns a read only copy of IDfType object disconnected from the current session.
|
java.lang.String |
IDfResultContent.getType()
Gets the content type of the content.
|
IDfSearchTypeAssistant |
IDfSearchMetadataManager.getTypeAssistant(java.lang.String typeName)
Provides access to a type assistant for the given type.
|
IDfSearchTypeAssistant |
IDfSearchMetadataManager.getTypeAssistant(java.lang.String typeName,
boolean includeObsoleteTypes)
Provides access to a type assistant for the given type.
|
java.lang.String |
IDfSearchTypeAssistant.getTypeLabel()
Gets the type label.
|
java.lang.String |
IDfResultObjectManager.getURL(IDfResultEntry entry)
Gets the URL where the result's content can be accessed.
|
IDfValueAssistance |
IDfSearchTypeAssistant.getValueAssistance(IDfExpression rootExpr,
IDfAttrExpression vaExpr)
Gets the value assistance of an attribute with dependencies to other attributes values.
|
IDfValueAssistance |
IDfSearchTypeAssistant.getValueAssistance(java.lang.String attrName)
Gets the value assistance of an attribute without dependencies to other attributes values.
|
java.lang.String |
IDfSearchTypeAssistant.getValueLabel(java.lang.String attrName,
java.lang.String searchOp,
java.lang.String value)
Deprecated.
|
IDfEnumeration |
IDfSearchTypeAssistant.getValues(java.lang.String attrName,
java.lang.String searchOp)
Deprecated.
|
boolean |
IDfSearchTypeAssistant.hasAttribute(java.lang.String attribute)
Checks if an attribute is available on the type.
|
boolean |
IDfSearchTypeAssistant.hasValueAssistance(java.lang.String attrName)
Indicates whether a value assistance is available for an attribute.
|
boolean |
IDfSearchTypeAssistant.hasValueAssistanceDependencies(java.lang.String attrName)
Indicates whether the value assistance of an attribute defines dependencies on other attributes values.
|
boolean |
IDfSearchTypeAssistant.isAttributeRepeated(java.lang.String attrName)
Tests if a given attribute is repeated.
|
boolean |
IDfSmartList.isLegacy()
Indicates whether this smart list is an old format.
|
boolean |
IDfResultObjectManager.isRepositoryObject(IDfResultEntry entry)
Indicates whether the result comes from a repository and can be accessed as a IDfSysObject.
|
boolean |
IDfResultObjectManager.isURLAdressible(IDfResultEntry entry)
Indicates if the result's content is accessible directly through a URL.
|
IDfQueryDefinition |
IDfQueryManager.loadQueryDefinition(java.io.InputStream in)
Loads a query definition from a stream.
|
IDfSmartList |
IDfSearchStoreService.loadSearch(java.lang.String ObjectId)
Gets a Search (before a load) using the ID.
|
IDfSmartListDefinition |
IDfQueryManager.loadSmartListDefinition(org.w3c.dom.Document doc,
org.w3c.dom.Node parentNode)
Loads a smart list definition from an XML document node.
|
IDfSmartListDefinition |
IDfQueryManager.loadSmartListDefinition(java.io.InputStream in)
Loads a smart list definition from a stream.
|
IDfPassThroughQuery |
IDfQueryManager.newPassThroughQuery(java.lang.String queryString)
Creates a new pass-through query using the specified parameters.
|
IDfPassThroughQuery |
IDfQueryManager.newPassThroughQuery(java.lang.String queryString,
java.lang.String customQueryData,
int maxResultCount)
Creates a new pass-through using the specified parameters.
|
IDfQueryBuilder |
IDfQueryManager.newQueryBuilder()
Creates a new query builder.
|
IDfQueryBuilder |
IDfQueryManager.newQueryBuilder(java.lang.String objectType)
Creates a new query builder using the specified object type.
|
IDfQueryBuilder |
IDfQueryManager.newQueryBuilder(java.lang.String objectType,
int maxResultCount,
boolean isDatabaseSearchRequested)
Creates a new query builder using the specified parameters.
|
IDfSmartListDefinition |
IDfQueryManager.newSmartListDefinition()
Creates a new smart list definition.
|
void |
IDfSearchSourceContainer.removeSelectedSource(java.lang.String sourceName)
Removes selected source.
|
java.lang.String |
IDfSmartList.save(java.lang.String location,
boolean withResults,
boolean isPrivate)
Stores this search.
|
void |
IDfQueryManager.saveQueryDefinition(IDfQueryDefinition queryDefinition,
java.io.OutputStream out)
Saves a query definition in an output stream.
|
void |
IDfQueryManager.saveSmartListDefinition(IDfSmartListDefinition smartList,
org.w3c.dom.Document doc,
org.w3c.dom.Node parentNode)
Saves a smart list definition in an output stream.
|
void |
IDfQueryManager.saveSmartListDefinition(IDfSmartListDefinition smartList,
java.io.OutputStream out)
Saves a smart list definition in an output stream.
|
void |
IDfModifiableResultEntry.setContentDescriptor(java.lang.String contentDescriptor)
Sets the descriptor of an external result content.
|
void |
IDfSmartList.setResultsSet(IDfResultsSet resultSet)
Sets the IDfResultsSet.
|
void |
IDfSearchResults.setResultsSet(IDfResultsSet resultSet)
Sets the IDfResultsSet.
|
void |
IDfSmartList.setSmartListDefinition(IDfSmartListDefinition smartList)
Sets the content of this dm_smart_list.
|
boolean |
IDfSearchStoreService.supportsResultsStorage()
Checks whether the new store search attributes are available in the repository.
|
void |
DfExpressionVisitor.visit(IDfExpressionSet expr)
Visits an
IDfExpressionSet . |
void |
DfExpressionVisitor.visit(IDfFullTextExpression expr)
Visits an
IDfFullTextExpression . |
void |
DfExpressionVisitor.visit(IDfRelativeDateExpression expr)
Visits an
IDfRelativeDateExpression . |
void |
DfExpressionVisitor.visit(IDfSimpleAttrExpression expr)
Visits an
IDfSimpleAttrExpression . |
void |
DfExpressionVisitor.visit(IDfValueListAttrExpression expr)
Visits an
IDfValueListAttrExpression . |
void |
DfExpressionVisitor.visit(IDfValueRangeAttrExpression expr)
Visits an
IDfValueRangeAttrExpression . |
Modifier and Type | Class and Description |
---|---|
class |
DfFilterException
An exception raised by a filter.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<IDfModifiableFacet> |
IDfFacetFilter.filterFacets(IDfContext context,
java.util.List<IDfModifiableFacet> facets)
This method can potentially be called multiple time for a query.
|
IDfQueryDefinition |
IDfQueryFilter.filterQuery(IDfContext context,
IDfQueryDefinition query) |
java.util.List<IDfModifiableResultEntry> |
IDfResultFilter.filterResults(IDfContext context,
java.util.List<IDfModifiableResultEntry> resultsBatch)
This method can be called several times per query
|
IDfGenerationContext.Language |
IDfGenerationContext.getTargetLanguage()
Indicate the target language that will be used to generate the query.
|
void |
IDfCompletionFilter.onComplete(IDfContext context) |
Modifier and Type | Class and Description |
---|---|
class |
DfValidationException
DfValidationException will be thrown when a validation rule is violated
|
Modifier and Type | Method and Description |
---|---|
static DfException |
DfException.appendException(DfException exptHead,
DfException e,
int stopAfterNumOfErrors)
Appends a DfException to the end of an exception chain.
|
static DfException |
DfException.convert(java.lang.Exception e) |
static DfException |
DfException.materializedLightObjectException(IDfId id) |
static DfException |
DfException.newAlreadyMaterializedException(IDfId objectId) |
static DfException |
DfException.newApiBadType(IDfId componentId,
java.lang.String typeName) |
static DfException |
DfException.newAspectMissingPropertyBag(java.lang.String aspectName,
IDfId objId,
java.lang.String typeName) |
static DfException |
DfException.newAuditTrailOutOfRangeException(int valueIndex,
java.lang.String attributeName,
int count) |
static DfException |
DfException.newBadCacheTypeNameException(java.lang.String cacheTypeName) |
static DfException |
DfException.newBadClassException(java.lang.String className,
java.lang.String baseClassName,
java.lang.Throwable cause) |
static DfException |
DfException.newBadDataTypeException(int dataType) |
static DfException |
DfException.newBadDateException(java.lang.String value,
java.lang.String pattern) |
static DfException |
DfException.newBadDocbaseScopeIdException(long docbaseId) |
static DfException |
DfException.newBadFlushArgException(java.lang.String flushType) |
static DfException |
DfException.newBadIdException(IDfId id) |
static DfException |
DfException.newBadTypeException(java.lang.String typeName) |
static DfException |
DfException.newCannotChangeSharedParentException() |
static DfException |
DfException.newCannotDestroyAspect(java.lang.String aspectName) |
static DfException |
DfException.newCantApplyException(java.lang.String methodName) |
static DfException |
DfException.newCantExportDirtyObjectException(IDfId id) |
static DfException |
DfException.newCantFetchInvalidId(java.lang.String objectId) |
static DfException |
DfException.newCantWithOpenTranException(java.lang.String operationName) |
static DfException |
DfException.newClassNotFoundException(java.lang.String className,
java.lang.Throwable cause) |
static DfException |
DfException.newDecodingFailedException(java.lang.String tokenName,
java.lang.String tokenValue,
java.lang.Throwable cause) |
static DfException |
DfException.newDeserializeFailedException(java.lang.String serializedValue,
java.lang.Throwable cause) |
static DfException |
DfException.newDynamicGroupUpdateException() |
static DfException |
DfException.newFailedPolicyUpdateException(java.lang.Throwable cause) |
static DfException |
DfException.newFlushDDCacheBadKeyException(java.lang.String cacheKey) |
static DfException |
DfException.newFlushDDCacheNoKeyException() |
static DfException |
DfException.newFlushRegistryCacheNoKeyException() |
static DfException |
DfException.newIllegalDateFormatException(java.lang.String value) |
static DfException |
DfException.newIllegalSBOAccessException(java.lang.String sboName) |
static DfException |
DfException.newInvalidAspectName(java.lang.String aspectName) |
static DfException |
DfException.newInvalidDefaultValue(java.lang.String typeName,
java.lang.String attrName,
java.lang.String defaultValue) |
static DfException |
DfException.newInvalidNewObjectException(java.lang.String typeName) |
static DfException |
DfException.newInvalidTypeException(java.lang.String typeName,
IDfId objectId,
java.lang.String requiredTypeName) |
static DfException |
DfException.newMaterializationOptionMismatchException(IDfId objectId) |
static DfException |
DfException.newMultipleObjectsQualify(java.lang.String predicate,
java.lang.String docbaseName) |
static DfException |
DfException.newNoCacheKeyException() |
static DfException |
DfException.newNoCacheNameException() |
static DfException |
DfException.newNoCacheTypeNameException() |
static DfException |
DfException.newNoEventNameException(java.lang.String commandName) |
static DfException |
DfException.newNoIdException(java.lang.String api) |
static DfException |
DfException.newProxyInstantiateFailedException(java.lang.String className,
java.lang.Throwable cause) |
static DfException |
DfException.newQueryFailException(java.lang.String dql,
java.lang.Throwable cause) |
static DfException |
DfException.newQuerySessionClosedException() |
static DfException |
DfException.newReplicaAspectGenerationFailed(java.lang.String className,
java.lang.Throwable cause) |
static DfException |
DfException.newRetentionOnParkedContentDisabled() |
static DfException |
DfException.newSerializeFailedException(java.lang.Object object,
java.lang.Throwable cause) |
static DfException |
DfException.newShareableTypeMismatchException(java.lang.String shareableTypeName) |
static DfException |
DfException.newTransactionActiveException() |
static DfException |
DfException.newTransactionLostException() |
static DfException |
DfException.newUnsupportedLoginTicketObjectVersionException(int version) |
static DfException |
DfException.newUpdateBadAttrException(java.lang.String attributeName) |
static DfException |
DfException.newWrongCacheNameException(java.lang.String cacheName) |
static DfException |
DfException.noLightweightParentTypeException(java.lang.String lwTypeName) |
static DfException |
DfException.notShareableParentTypeException(java.lang.String lwTypeName) |
Modifier and Type | Method and Description |
---|---|
static DfException |
DfException.appendException(DfException exptHead,
DfException e,
int stopAfterNumOfErrors)
Appends a DfException to the end of an exception chain.
|
void |
DfException.setNextException(DfException nextException) |
Modifier and Type | Method and Description |
---|---|
int |
IDfList.append(java.lang.Object value)
Appends an Object instance to the list.
|
int |
IDfList.appendBoolean(boolean value)
Appends a boolean value to the list.
|
int |
IDfList.appendDouble(double value)
Appends a double value to the list.
|
static DfException |
DfException.appendException(DfException exptHead,
DfException e,
int stopAfterNumOfErrors)
Appends a DfException to the end of an exception chain.
|
int |
IDfList.appendId(IDfId value)
Appends an instance of an IDfId object to the list.
|
int |
IDfList.appendInt(int value)
Appends an int value to the list.
|
int |
IDfList.appendList(IDfList value)
Appends an instance of an IDfList object to the list.
|
int |
IDfList.appendString(java.lang.String value)
Appends a string value to the list.
|
int |
IDfList.appendTime(IDfTime value)
Appends an instance of an IDfTime object to the list.
|
int |
IDfList.appendValue(IDfValue value)
Appends an instance of an IDfValue object to the list.
|
int |
IDfValue.compareTo(IDfValue value)
Indicates whether the value stored in the calling value object is less than, equal to,
or greater than the value stored in a user-supplied value object.
|
int |
IDfList.findBooleanIndex(boolean value)
Returns the index of the first occurrence of a boolean value in the list.
|
int |
IDfList.findDoubleIndex(double value)
Returns the index of the first occurrence of a double value in the list.
|
int |
IDfList.findIdIndex(IDfId value)
Returns the index of the first occurrence of an IDfId object in the list.
|
int |
IDfList.findIndex(java.lang.Object value)
Returns the index of the first occurrence of the Object in the list.
|
int |
IDfList.findIntIndex(int value)
Returns the index of the first occurrence of an int value in the list.
|
int |
IDfList.findListIndex(IDfList value)
Returns the index of the first occurrence of an IDfList object in the list.
|
int |
IDfList.findStringIndex(java.lang.String value)
Returns the index of the first occurrence of a string value in the list.
|
int |
IDfList.findTimeIndex(IDfTime value)
Returns the index of the first occurrence of an IDfTime object in the list.
|
int |
IDfList.findValueIndex(IDfValue value)
Returns the index of the first occurrence of an IDfValue object in the list.
|
java.lang.Object |
IDfList.get(int index)
Fetches an Object instance from the list at the specified index.
|
boolean |
IDfList.getBoolean(int index)
Fetches a boolean value from the list at the specified index.
|
boolean |
IDfProperties.getBoolean(java.lang.String propertyName)
Returns the boolean value to which the specified property name is mapped to in
the object.
|
double |
IDfList.getDouble(int index)
Fetches a double value from the list at the specified index.
|
double |
IDfProperties.getDouble(java.lang.String propertyName)
Returns the value to which the specified property name is mapped to in the object.
|
int |
IDfList.getElementTypeAt(int index)
Returns the datatype of the items added to the list at the specified
index.
|
IDfId |
IDfList.getId(int index)
Fetches an instance of an IDfId object from the list at the specified index.
|
IDfId |
IDfProperties.getId(java.lang.String propertyName)
Returns an IDfId interface to which the specified property name is mapped to in
the object.
|
int |
IDfList.getInt(int index)
Fetches an int value from the list at the specified index.
|
int |
IDfProperties.getInt(java.lang.String propertyName)
Returns the value to which the specified property name is mapped to in the object.
|
double |
IDfSearchable.getKeyAt(int index)
Returns the integer element at the specified index.
|
IDfList |
IDfList.getList(int index)
Fetches an instance of an IDfList object from the list at the specified index.
|
IDfList |
IDfProperties.getList(java.lang.String propertyName)
Returns an IDfList interface to which the specified property name is mapped to in the object.
|
javax.management.MBeanServer |
IDfMBeanServerProvider.getMBeanServer()
Returns a handle to a specific MBeanServer, depending on the application
server against which this has been implemented.
|
java.lang.String |
IDfMBeanServerProvider.getMBeanServerDomain() |
IDfList |
IDfProperties.getProperties()
Returns the property names as an IDfList interface.
|
int |
IDfProperties.getPropertyType(java.lang.String propertyName)
Return the datatype of the mapped property value.
|
java.lang.String |
IDfList.getString(int index)
Fetches a string value from the list at the specified index.
|
java.lang.String |
IDfProperties.getString(java.lang.String propertyName)
Returns the string to which the specified property name is mapped to in the object.
|
IDfTime |
IDfList.getTime(int index)
Fetches an instance of an IDfTime object from the list at the specified index.
|
IDfTime |
IDfProperties.getTime(java.lang.String propertyName)
Returns an IDfTime interface to which the specified property name is mapped to
in the object.
|
IDfValue |
IDfList.getValue(int index)
Fetches an instance of an IDfValue object from the list at the specified index.
|
IDfValue |
IDfProperties.getValue(java.lang.String propertyName)
Returns an IDfValue interface to which the specified property name is mapped to
in the object.
|
void |
IDfList.insert(int index,
java.lang.Object value)
Inserts an Object instance into the list at a specified index.
|
void |
IDfList.insertAll(int index,
IDfList list)
Inserts all objects contained in an IDfList object into the list at a specified index.
|
void |
IDfList.insertBoolean(int index,
boolean value)
Inserts a boolean value into the list at a specified index.
|
void |
IDfList.insertDouble(int index,
double value)
Inserts a double value into the list at a specified index.
|
void |
IDfList.insertId(int index,
IDfId value)
Inserts an instance of an IDfId object into the list at a specified index.
|
void |
IDfList.insertInt(int index,
int value)
Inserts an int value into the list at a specified index.
|
void |
IDfList.insertList(int index,
IDfList value)
Inserts an instance of an IDfList object into the list at a specified index.
|
void |
IDfList.insertString(int index,
java.lang.String value)
Inserts a string value into the list at a specified index.
|
void |
IDfList.insertTime(int index,
IDfTime value)
Inserts an instance of an IDfTime object into the list at a specified index.
|
void |
IDfList.insertValue(int index,
IDfValue value)
Inserts an instance of an IDfValue object into the list at a specified index.
|
void |
IDfList.remove(int index)
Removes an item from the list at the specified index.
|
void |
IDfList.set(int index,
java.lang.Object value)
Adds an Object instance into the list at a specified index.
|
void |
IDfList.setBoolean(int index,
boolean value)
Adds a boolean value into the list at a specified index.
|
void |
IDfList.setDouble(int index,
double value)
Adds a double value into the list at a specified index.
|
void |
IDfList.setId(int index,
IDfId value)
Adds an instance of an IDfId interface into the list at a specified index.
|
void |
IDfList.setInt(int index,
int value)
Adds an int value into the list at a specified index.
|
void |
IDfList.setList(int index,
IDfList value)
Adds an instance of an IDfList interface into the list at a specified index.
|
void |
IDfList.setString(int index,
java.lang.String value)
Adds a string value into the list at a specified index.
|
void |
IDfList.setTime(int index,
IDfTime value)
Adds an instance of an IDfTime interface into the list at a specified index.
|
void |
IDfList.setValue(int index,
IDfValue value)
Adds an instance of an IDfValue interface into the list at a specified index.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfLifecycleAction.action(IDfSysObject sysObj,
java.lang.String userName,
java.lang.String targetState,
java.util.Map parameters)
System-defined action on an object entering a new Lifecycle state.
|
void |
IDfLifecycleUserAction.userAction(IDfSysObject sysObj,
java.lang.String userName,
java.lang.String targetState)
User defined actions on an object entering a new Lifecycle state.
|
boolean |
IDfLifecycleUserEntryCriteria.userEntryCriteria(IDfSysObject sysObj,
java.lang.String userName,
java.lang.String targetState)
User defined entry criteria to determine if an object can enter a new Lifecycle state.
|
void |
IDfLifecycleUserPostProcessing.userPostProcessing(IDfSysObject sysObj,
java.lang.String userName,
java.lang.String targetState)
User defined actions on an object after it has moved to a new Lifecycle state.
|
boolean |
IDfLifecycleValidate.userValidate(IDfSysObject lifecycleObj,
java.lang.String userName)
User defined validation to determine if Lifecycle can be installed.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfOperation.abort()
Abort the operation.
|
IDfOperationNode |
IDfOperationNodeTreeBuilder.add(IDfOperationNode parentNode,
IDfNodeRelationship nodeRelationship,
java.lang.Object obj)
Results in appending a node for the corresponding object as a child node of the given parentNode by iterating
through list of populators for the operation.
|
IDfOperationNode |
IDfOperationNodeTreeBuilder.add(java.lang.Object obj)
This method results in adding a node for the corresponding object as root node.
|
IDfOperationNode |
IDfOperation.add(java.lang.Object newObject)
Adds an object to the operation and returns an operation node
for the newly added object.
|
boolean |
IDfOperation.canUndo()
Indicates whether the operation can be undone.
|
void |
IDfVDMPlatformUtils.copyFile(java.lang.String sourceFile,
java.lang.String destFile) |
void |
IDfStepAction.execute()
The business logic of the step action.
|
boolean |
IDfOperationStep.execute()
Executes the action(s) of the step, for example a "check in" step would cause
the objects in the operation to each be checked in to the docbase.
|
boolean |
IDfOperation.execute()
Execute the operation.
|
IDfEnumeration |
IDfExportNode.getAcsRequests()
Returns an
IDfEnumeration object containing a list of IDfAcsRequest objects. |
IDfEnumeration |
IDfCheckoutNode.getAcsRequests()
Returns an
IDfEnumeration object with a list of IDfAcsRequest objects. |
java.lang.String |
IDfXMLUtils.getApplication(java.lang.String applicationName,
boolean returnSingleApp)
Deprecated.
DFC 5.2
|
java.lang.String |
IDfXMLUtils.getApplicationByDTD(java.lang.String dtdSystemId,
java.lang.String dtdPublicId,
java.lang.String namespace,
java.lang.String rootElement,
boolean returnSingleApp)
Deprecated.
DFC 5.2.
|
IDfList |
IDfXMLUtils.getApplicationList(IDfXMLDocType doctype)
Returns a list strings containing object IDs and object names.
|
IDfList |
IDfXMLUtils.getApplicationList(IDfXMLDocType doctype,
IDfFile file)
Returns a list strings containing object IDs and object names.
|
IDfList |
IDfXMLUtils.getApplicationList(IDfXMLDocType doctype,
IDfFormat formatObj)
Returns a list strings containing object IDs and object names.
|
IDfList |
IDfXMLUtils.getApplicationList(IDfXMLDocType doctype,
IDfSysObject object)
Returns a list strings containing object IDs and object names.
|
IDfList |
IDfXMLUtils.getApplicationList(IDfXMLDocType doctype,
java.lang.String fileOrFormatName)
Returns a list strings containing object IDs and object names.
|
IDfList |
IDfXMLUtils.getApplicationList(java.lang.String applicationName)
Return a list of object IDs.
|
IDfList |
IDfXMLUtils.getApplicationListByDTD(java.lang.String dtdSystemId,
java.lang.String dtdPublicId,
java.lang.String namespace,
java.lang.String rootElement,
boolean returnSingleApp)
Deprecated.
DFC 5.2
|
int |
IDfCheckinOperation.getCheckinVersion()
Returns an integer indicating how versioning should be handled on check in.
|
int |
IDfCheckinNode.getCheckinVersion()
Returns an integer indicating how versioning should be handled on check in.
|
IDfList |
IDfOperationNode.getChildren()
Returns a list of the immediate children of this node.
|
java.lang.String |
IDfVDMPlatformUtils.getCLSIDForFile(java.lang.String filePath) |
int |
IDfPredictiveCachingNode.getContentPageNumber()
Returns the content page number for the local content file for this object.
|
int |
IDfExportNode.getContentPageNumber()
Returns the content page number for the local content fille for this object.
|
int |
IDfCheckinNode.getContentPageNumber()
Returns the content page number for the local content file for this object.
|
int |
IDfCopyOperation.getCopyOptionsFlag()
Returns the current copy option settings.
|
int |
IDfCopyOperation.getCopyPreference()
Returns an integer representing the copy option settings for the operation.
|
boolean |
IDfCopyOperation.getDeepFolders()
When working with folders, copy the folder and all of its descendants.
|
java.lang.String |
IDfExportOperation.getDefaultDestinationDirectory()
Returns the default file system directory path that is the
output location for the outbound content files.
|
java.lang.String |
IDfCheckoutOperation.getDefaultDestinationDirectory()
Returns the default file system directory path that is the
output location for the outbound content files.
|
java.lang.String |
IDfPredictiveCachingNode.getDefaultFormat()
Returns the default content file format for this object in the repository.
|
java.lang.String |
IDfImportNode.getDefaultFormat()
Returns the default repository format name for the local content file of this object.
|
java.lang.String |
IDfExportNode.getDefaultFormat()
Returns the default content file format for this object in the repository.
|
java.lang.String |
IDfCheckoutNode.getDefaultFormat()
Returns the default content file format for this object in the repository.
|
java.lang.String |
IDfCheckinNode.getDefaultFormat()
Returns the default repository format name for the local content file of this object.
|
java.lang.String |
IDfFormatRecognizer.getDefaultSuggestedFileFormat()
Returns the repository format name that should be considered the default
choice for the file being recognized.
|
java.lang.String |
IDfOperationStep.getDescription()
Returns the localized description of this step.
|
java.lang.String |
IDfOperation.getDescription()
Returns the description of the operation.
|
java.lang.String |
IDfValidationOperation.getDestinationDirectory()
Gets the destination directory where the temporary file will be placed
during validation of xml file.
|
java.lang.String |
IDfExportOperation.getDestinationDirectory()
Returns the file system directory path that is the default
output location for the outbound content files.
|
java.lang.String |
IDfCheckoutOperation.getDestinationDirectory()
Returns the file system directory path that is the default
output location for the outbound content files.
|
IDfId |
IDfMoveOperation.getDestinationFolderId()
Returns the docbase object Id of the destination folder for the move operation.
|
IDfId |
IDfMoveNode.getDestinationFolderId()
This is the folder where objects are being moved (linked).
|
IDfId |
IDfImportOperation.getDestinationFolderId()
Returns the docbase object Id of the destination folder for the copy operation.
|
IDfId |
IDfImportNode.getDestinationFolderId()
Returns the repository object ID of the destination folder for the copy operation.
|
IDfId |
IDfCopyOperation.getDestinationFolderId()
Returns the repository object ID of the destination folder for the copy operation.
|
IDfId |
IDfCopyNode.getDestinationFolderId()
Returns the repository object ID of the destination folder for this node.
|
java.lang.String |
IDfImportNode.getDocbaseObjectType()
Returns the repository object type that is used to create the new
repository object for the import node.
|
IDfProperties |
IDfOperationNode.getEdgeProperties()
Retuns the propertes of the edge between this node and its immediate parent.
|
IDfList |
IDfOperation.getErrors()
Returns the list of operation errors.
|
java.lang.String |
IDfImportNode.getExternalVariable(java.lang.String varName)
Returns the value of an external variable.
|
java.lang.String |
IDfCheckinNode.getExternalVariable(java.lang.String varName)
Returns the value of an external variable.
|
java.lang.String |
IDfImportNode.getFilePath()
Returns the canonical path to the content file on the local file system for this node.
|
java.lang.String |
IDfExportNode.getFilePath()
Returns the content file path in the local file system for this node.
|
java.lang.String |
IDfCheckoutNode.getFilePath()
Returns the content file path in the local file system for this node.
|
java.lang.String |
IDfCheckinNode.getFilePath()
Returns the content file path in the local file system for this node.
|
java.lang.String |
IDfPredictiveCachingNode.getFormat()
Returns the repository format name for the local content file of this object.
|
java.lang.String |
IDfImportNode.getFormat()
Returns the repository format name for the local content file of this object.
|
java.lang.String |
IDfExportNode.getFormat()
Returns the repository format name for the local content file of this object.
|
java.lang.String |
IDfCheckoutNode.getFormat()
Returns the repository format name for the local content file of this object.
|
java.lang.String |
IDfCheckinNode.getFormat()
Returns the repository format name for the local content file of this object.
|
IDfId |
IDfOperationNode.getId()
Returns a unique identifier for this node.
|
boolean |
IDfImportOperation.getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
boolean |
IDfImportNode.getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
boolean |
IDfCheckinOperation.getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
boolean |
IDfCheckinNode.getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
boolean |
IDfCancelCheckoutOperation.getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
boolean |
IDfCancelCheckoutNode.getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the cancel checkout operation.
|
IDfEnumeration |
IDfPredictiveCachingNode.getMessageIds()
Returns message IDs for all messages that have been created during the operation.execute()
method for this node
|
java.lang.String |
IDfOperationStep.getName()
Returns the name of the operation step.
|
java.lang.String |
IDfOperation.getName()
Returns the name of the operation (e.g.
|
IDfList |
IDfPredictiveCachingOperation.getNetworkLocationIds()
Returns a list of the network location identifiers to be used for content pre-caching.
|
IDfSysObject |
IDfImportNode.getNewObject()
Returns the new IDfSysObject resulting from the check in.
|
IDfSysObject |
IDfCopyNode.getNewObject()
Returns the new IDfSysObject resulting from the copy.
|
IDfSysObject |
IDfCheckinNode.getNewObject()
Returns the new IDfSysObject resulting from the check in.
|
IDfId |
IDfImportNode.getNewObjectId()
Returns the new repository object ID for the IDfSysObject resulting from the check in.
|
IDfId |
IDfCopyNode.getNewObjectId()
Returns the new repository object ID for the IDfSysObject resulting from the copy.
|
IDfId |
IDfCheckinNode.getNewObjectId()
Returns the new repository object ID for the IDfSysObject resulting from the check in.
|
java.lang.String |
IDfImportNode.getNewObjectName()
Returns the object name to be used for the newly imported object.
|
java.lang.String |
IDfCopyNode.getNewObjectName()
Returns the object name used for the newly copied object.
|
IDfList |
IDfImportOperation.getNewObjects()
Returns the list of unique new objects created as a result of this operation.
|
IDfList |
IDfCopyOperation.getNewObjects()
Returns the list of unique new objects created as a result of this operation.
|
IDfList |
IDfCheckinOperation.getNewObjects()
Returns the list of unique new objects created as a result of this operation.
|
IDfList |
IDfOperation.getNodes()
Returns the list of all operation nodes.
|
IDfSysObject |
IDfPredictiveCachingNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfMoveNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfImportNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfExportNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfDeleteNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfCopyNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfCheckoutNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfSysObject |
IDfCheckinNode.getObject()
Returns the original IDfSysObject before check in.
|
IDfSysObject |
IDfCancelCheckoutNode.getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfId |
IDfPredictiveCachingNode.getObjectId()
Returns the repository object ID of the IDfSysObject for this node.
|
IDfId |
IDfMoveNode.getObjectId()
Returns the docbase object Id of the IDfSysObject for this node.
|
IDfId |
IDfImportNode.getObjectId()
Returns the repository object ID of the IDfSysObject for this node.
|
IDfId |
IDfExportNode.getObjectId()
Returns the repository object Id of the IDfSysObject for this node.
|
IDfId |
IDfDeleteNode.getObjectId()
Returns the repository object ID of the IDfSysObject for this node.
|
IDfId |
IDfCopyNode.getObjectId()
Returns the repository object ID of the IDfSysObject for this node.
|
IDfId |
IDfCheckoutNode.getObjectId()
Returns the repository object Id of the IDfSysObject for this node.
|
IDfId |
IDfCheckinNode.getObjectId()
Returns the original repository object ID for the IDfSysObject before check in.
|
IDfId |
IDfCancelCheckoutNode.getObjectId()
Returns the docbase object Id of the IDfSysObject for this node.
|
IDfId |
IDfXMLUtils.getObjectIdFromDRL(java.lang.String drl)
Returns the object id corresponding to the DRL.
|
IDfList |
IDfPredictiveCachingOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfMoveOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfExportOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfDeleteOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfCopyOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfCheckoutOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfCheckinOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfCancelCheckoutOperation.getObjects()
Returns the list of unique objects in this operation.
|
IDfList |
IDfXMLUtils.getObjectTypes(java.lang.String xmlApplication)
getObjectTypes - RESERVED FOR FUTURE USE.
|
java.lang.String |
IDfOperation.getOperationType()
Returns the type of the operation.
|
java.lang.String |
IDfPredictiveCachingNode.getPageModifier()
Returns the content page modifier for the local content file for this object.
|
java.lang.String |
IDfExportNode.getPageModifier()
Returns the content page modifier for the local content file for this object.
|
IDfOperationNode |
IDfOperationNode.getParent()
Returns the node that is the immediate parent of this node.
|
IDfProperties |
IDfOperationNode.getProperties()
Returns the properties of this node.
|
IDfProperties |
IDfOperation.getProperties()
Returns the properties of the operation.
|
int |
IDfExportOperation.getRecordInRegistry()
Returns an integer that indicates if this node should be
recorded in the client registry.
|
int |
IDfExportNode.getRecordInRegistry()
Returns an integer that indicates if this node should be
recorded in the client registry.
|
boolean |
IDfCheckinOperation.getRetainLock()
Returns true if the docbase object for this node should keep the lock after check in.
|
boolean |
IDfCheckinNode.getRetainLock()
Returns true if the repository object for this node should keep the lock after check in.
|
IDfList |
IDfOperation.getRootNodes()
Returns a list of the root level nodes of the operation.
|
IDfSession |
IDfOperation.getSession()
Returns session to be used during operation execution
|
IDfSession |
IDfImportOperation.getSession()
Returns session to be used to import new objects.
|
IDfId |
IDfMoveOperation.getSourceFolderId()
Gets the source folder id for the move operation.
|
IDfId |
IDfMoveNode.getSourceFolderId()
This is the folder from which objects are being moved (unlinked).
|
IDfList |
IDfOperation.getSteps()
Returns the list of operation steps.
|
IDfList |
IDfFormatRecognizer.getSuggestedFileFormats()
Returns a list of format choices for a given
file path.
|
java.lang.String |
IDfFile.getURI()
Return the absolute path for the file as a URI.
|
int |
IDfDeleteOperation.getVersionDeletionPolicy()
Returns the delete operation population type.
|
java.lang.String |
IDfImportOperation.getVersionLabels()
Returns the symbolic version labels that will be applied when the
node is checked in.
|
java.lang.String |
IDfImportNode.getVersionLabels()
Returns the symbolic version labels that are applied when the
node is checked in.
|
java.lang.String |
IDfCheckinOperation.getVersionLabels()
Returns the symbolic version labels that will be applied when the
node is checked in.
|
java.lang.String |
IDfCheckinNode.getVersionLabels()
Returns the symbolic version labels that will be applied when the
node is checked in.
|
IDfXMLDocType |
IDfXMLUtils.getXMLDoctypeFromFile(java.lang.String filename)
Returns an IDfXMLDocType which encapsulates information from the given XML document: public ID, system ID,
schemaLocation, root element and XML application (if a processing instruction was found that indicates the XML application.
|
int |
IDfOperationMonitor.getYesNoAnswer(IDfOperationError question)
Called by operation when an error / warning requires a yes or no response.
|
IDfList |
IDfXMLUtils.getZones(java.lang.String xmlApplication)
getZones - RESERVED FOR FUTURE USE.
|
boolean |
IDfImportNode.isEnabledOLELinksProcessing()
Returns true if OLE links processing is enabled
|
boolean |
IDfCheckinNode.isEnabledOLELinksProcessing()
Returns true if OLE links processing is enabled
|
boolean |
IDfXMLUtils.isHTML(java.lang.Object fileOrFormatObj)
isHTML - RESERVED FOR FUTURE USE.
|
boolean |
IDfOperationNode.isRoot()
Returns
true if this node is a root level node (has no parent). |
boolean |
IDfXMLUtils.isXML(java.lang.Object fileOrFormatObject)
Returns a boolean value to indicate whether the given
file or format is XML, in terms of XML processing (i.e. chunking).
|
void |
IDfOperation.logError(IDfOperationError error)
Records an operation error.
|
IDfOperationNode |
IDfOperationNodeFactory.newNode(IDfFile file)
Creates a new node for the given file.
|
IDfOperationNode |
IDfOperationNodeFactory.newNode(IDfId id)
Creates a new node for the given object.
|
IDfOperationNode |
IDfOperationNodeFactory.newNode(IDfInputStreamContent inputStreamContent)
Creates a new node for the given inputStream.
|
IDfNodeRelationship |
IDfOperationNodeFactory.newNodeRelationship(IDfId parentId,
IDfId childId,
java.lang.String relationType) |
IDfOperationNode |
IDfNodePopulator.process(java.lang.Object newObject)
Builds an IDfOperationNode
|
int |
IDfOperationMonitor.progressReport(IDfOperation operation,
int operationPercentDone,
IDfOperationStep step,
int stepPercentDone,
IDfOperationNode node) |
void |
IDfOperation.removeNode(IDfOperationNode nodeToRemove)
Removes an operation node (and its descendants) from the operation.
|
int |
IDfOperationMonitor.reportError(IDfOperationError error)
This method is called when an operation informs the monitor of
the occurance of an error.
|
void |
IDfOperation.reportError(IDfOperationNode node,
int errorCode,
java.lang.String message,
IDfException dfException)
Report an error.
|
void |
IDfOperation.resetErrors()
Clears any logged errors for this operation.
|
void |
IDfOperationContext.set(java.lang.String key,
java.lang.String value)
Allows setting contextual information in the form of key, value pair.
|
void |
IDfCheckinOperation.setCheckinVersion(int checkinVersion)
Returns an integer indicating how versioning should be handled on check in.
|
void |
IDfCheckinNode.setCheckinVersion(int checkinVersion)
Takes an integer indicating how versioning should be handled on check in.
|
void |
IDfPredictiveCachingNode.setContentPageNumber(int pageNumber)
Sets the content page number for the local content file of this object.
|
void |
IDfExportNode.setContentPageNumber(int pageNumber)
Sets the content page number for the local content fille of this object.
|
void |
IDfCheckinNode.setContentPageNumber(int pageNumber)
Sets the content page number for the local content file of this object.
|
void |
IDfCopyOperation.setDeepFolders(boolean deepFolders)
When working with folders, copy the folder and all of its descendants.
|
void |
IDfXMLTransformOperation.setDestination(java.lang.Object destinationObject)
Specify the transformed document's destination.
|
void |
IDfXMLTransformNode.setDestination(java.lang.Object destinationObject)
Specify the transformed document's destination.
|
void |
IDfValidationOperation.setDestinationDirectory(java.lang.String dirPath)
Sets the destination directory where the temporary file will be placed
during validation of xml file.
|
void |
IDfExportOperation.setDestinationDirectory(java.lang.String dirPath)
Sets the file system directory path that is the default
output location for the outbound content files.
|
void |
IDfCheckoutOperation.setDestinationDirectory(java.lang.String dirPath)
Sets the file system directory path that is the default
output location for the outbound content files.
|
void |
IDfMoveOperation.setDestinationFolderId(IDfId folderId)
Sets the docbase object Id for the destination folder for the move operation.
|
void |
IDfMoveNode.setDestinationFolderId(IDfId destFolderId)
Sets the docbase object Id of the destination folder for this node.
|
void |
IDfImportOperation.setDestinationFolderId(IDfId destinationFolderId)
Sets the docbase object Id for the destination folder for the copy operation.
|
void |
IDfImportNode.setDestinationFolderId(IDfId destinationFolderId)
Sets the repository object ID for the destination folder for the copy operation.
|
void |
IDfCopyOperation.setDestinationFolderId(IDfId folderId)
Sets the repository object ID for the destination folder for the copy operation.
|
void |
IDfCopyNode.setDestinationFolderId(IDfId destinationFolderId)
Sets the repository object ID of the destination folder for this node.
|
void |
IDfImportNode.setDocbaseObjectType(java.lang.String docbaseType)
Sets the repository object type that is used to create the new
repository object for the import node.
|
void |
IDfCheckoutNode.setExportDescendants(boolean exportDescendants)
If the object corresponding to this node is added as a virtual document, passing
true will
cause the object to be checked out, but all the descendants will be downloaded but not checked out. |
void |
IDfImportNode.setExternalVariable(java.lang.String varName,
java.lang.String value)
Sets a variable that is available to the XML application's configuration file as an <external_variable>.
|
void |
IDfCheckinNode.setExternalVariable(java.lang.String varName,
java.lang.String value)
Sets a variable that will be available to the XML application's configuration file as an <external_variable>.
|
void |
IDfImportNode.setFilePath(java.lang.String newFilePath)
Sets the file path to use as the contents of this object.
|
void |
IDfExportNode.setFilePath(java.lang.String newFilePath)
Sets the file path to use as the contents of this object.
|
void |
IDfCheckoutNode.setFilePath(java.lang.String newFilePath)
Sets the local path to the file that contains the content of this node.
|
void |
IDfCheckinNode.setFilePath(java.lang.String newFilePath)
Sets the file path to use as the content for this object.
|
void |
IDfPredictiveCachingNode.setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
void |
IDfImportNode.setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
void |
IDfExportNode.setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
void |
IDfCheckoutNode.setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
void |
IDfCheckinNode.setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
void |
IDfXMLTransformNode.setInputFormat(java.lang.String inputFormat)
Specify the input format for input object.
|
void |
IDfImportOperation.setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
IDfImportNode.setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
IDfCheckinOperation.setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
IDfCheckinNode.setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
IDfCancelCheckoutOperation.setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
IDfCancelCheckoutNode.setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
IDfExportNode.setLogicalPageRange(int startPage,
int endPage)
Sets the page range of interest that needs to be retrieved as a result of the execution of the export operation.
|
void |
IDfXMLTransformNode.setName(java.lang.String name)
Sets the name for this input transform node.
|
void |
IDfPredictiveCachingOperation.setNetworkLocationIds(IDfList networkLocationIds)
Sets the list of the network location identifiers to be used for content pre-caching.
|
void |
IDfImportNode.setNewObjectName(java.lang.String newObjectName)
Sets the name to be used for the new copy of the object.
|
void |
IDfCopyNode.setNewObjectName(java.lang.String newObjectName)
Sets the name for the new copy of the object.
|
IDfOperationMonitor |
IDfOperation.setOperationMonitor(IDfOperationMonitor monitor)
Sets the interface to be used to monitor events in the operation.
|
void |
IDfXMLTransformNode.setOutputFormat(java.lang.String outputFormat)
Specify the destination format for the output of the transformation.
|
void |
IDfPredictiveCachingNode.setPageModifier(java.lang.String pageModifier)
Sets the content page modifier for the local content file for this object.
|
void |
IDfExportNode.setPageModifier(java.lang.String pageModifier)
Sets the content page modifier for the local content file for this object.
|
void |
IDfExportOperation.setRecordInRegistry(int registryRecordingPreference)
Sets an integer that indicates if this node should be
recorded in the client registry.
|
void |
IDfExportNode.setRecordInRegistry(int registryRecordingPreference)
Sets an integer that indicates if this node should be
recorded in the client registry.
|
void |
IDfCheckinOperation.setRetainLock(boolean retainLock)
Sets whether or not the docbase object for this node should keep the lock after check in.
|
void |
IDfCheckinNode.setRetainLock(boolean retainLock)
Sets whether or not the repository object for this node should keep the lock after check in.
|
void |
IDfXMLTransformOperation.setSession(IDfSession session)
Set the session that will be used by this operation.
|
void |
IDfXMLTransformNode.setSession(IDfSession session)
Set the session that will be used by this operation.
|
void |
IDfOperation.setSession(IDfSession session)
Sets the session that will be used during operation execution.
|
void |
IDfImportOperation.setSession(IDfSession importSession)
Sets the session that will be used to create new docbase objects.
|
void |
IDfMoveOperation.setSourceFolderId(IDfId sourceFolderId)
Sets the source folder id for the move operation.
|
void |
IDfMoveNode.setSourceFolderId(IDfId sourceFolderId)
Sets the docbase object Id of the source folder for this node.
|
void |
IDfXMLTransformOperation.setTransformation(java.lang.Object transformObject)
Specify the XSLT transformation object that will be applied to the input.
|
void |
IDfXMLTransformNode.setTransformation(java.lang.Object transformObject)
Specify the XSLT transformation object that will be applied to this input node.
|
void |
IDfDeleteOperation.setVersionDeletionPolicy(int whichVersions)
Sets the delete operation population type.
|
void |
IDfImportOperation.setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that will be applied when the
node is checked in.
|
void |
IDfImportNode.setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that are applied when the
node is checked in.
|
void |
IDfCheckinOperation.setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that will be applied when the
node is checked in.
|
void |
IDfCheckinNode.setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that will be applied when the
node is checked in.
|
void |
IDfXMLTransformOperation.setXSLTParameter(java.lang.String paramName,
java.lang.String value)
Specify a parameter that will be passed to the stylesheet.
|
boolean |
IDfOperation.succeeded(java.lang.Object object)
Check if the operation succeded for the specified object.
|
boolean |
IDfDeleteNode.wasDeleted()
Returns true if the object for this node was actually deleted as
the result of this operation.
|
Modifier and Type | Method and Description |
---|---|
IDfCheckedOutObject |
IDfClientRegistry.addCheckedOutObject(IDfSysObject sysObject,
java.lang.String filePath,
boolean keepLocalFile,
java.lang.String folderPath)
Constructs a DfCheckedOutObject and writes it to the registry
|
void |
IDfViewedObject.addFilePath(java.lang.String filePath)
Adds the file path to the existing viewed object.
|
void |
IDfClientRegistry.addFileToBeDeleted(java.lang.String filePath)
Adds a file to the "to be deleted" list in the registry
|
IDfLocalObject |
IDfClientRegistry.addLocalObject(IDfSysObject sysObject,
java.lang.String filePath,
boolean keepLocalFile,
java.lang.String folderPath)
Constructs a DfLocalObject and writes it to the registry
|
void |
IDfCheckedOutObject.addSharedDocument(IDfId parentId)
Adds the object id of the parent that shares this checked out object.
|
IDfViewedObject |
IDfClientRegistry.addViewedObject(IDfSysObject sysObject,
java.lang.String filePath,
java.lang.String folderPath)
Constructs a DfViewedObject and writes it to the registry
|
void |
IDfClientRegistry.applyModifiedAttrs(IDfSysObject sysObject)
updates a checked-out object's attributes with those from a sysobject
|
void |
IDfRegistry.closeKey() |
void |
IDfRegistry.createKey() |
void |
IDfRegistry.deleteSubKey(java.lang.String subKey) |
void |
IDfRegistry.deleteSubKeys() |
void |
IDfRegistry.deleteValue(java.lang.String name) |
void |
IDfRegistry.flush() |
IDfList |
IDfRegistry.getBinaryValue(java.lang.String name) |
IDfList |
IDfRegistry.getBinaryValueAt(java.lang.String name,
int index) |
IDfList |
IDfRegistry.getBinaryValues(java.lang.String name) |
IDfCheckedOutObject |
IDfClientRegistry.getCheckedOutObjectById(IDfId objectId)
Finds a checked-out file registry object based on object ID
|
IDfCheckedOutObject |
IDfClientRegistry.getCheckedOutObjectByPath(java.lang.String filePath)
Finds a checked-out file registry object based on file path
|
IDfList |
IDfClientRegistry.getCheckedOutObjects()
Gets all the checked out objects
|
java.lang.String |
IDfClientRegistry.getCheckoutDirectory() |
java.lang.String |
IDfClientRegistry.getExportDirectory() |
IDfList |
IDfViewedObject.getFilePaths()
It is possible that the given viewed object may have more than one
file path.
|
IDfList |
IDfClientRegistry.getFilesToBeDeleted()
Gets the list of files to be deleted
|
int |
IDfRegistry.getIntValue(java.lang.String name) |
int |
IDfRegistry.getIntValueAt(java.lang.String name,
int index) |
IDfList |
IDfRegistry.getIntValues(java.lang.String name) |
IDfLocalObject |
IDfClientRegistry.getLocalObjectById(IDfId objectId)
Finds a local file registry object based on object ID
|
IDfLocalObject |
IDfClientRegistry.getLocalObjectByPath(java.lang.String filePath)
Finds a local file registry object based on object ID
|
IDfList |
IDfClientRegistry.getLocalObjects()
Gets all the checked out objects
|
java.lang.String |
IDfCheckedOutObject.getMasterObjectId()
Returns the master object id of the current checked out object.
|
java.lang.String |
IDfCheckedOutObject.getModifiedAttr(java.lang.String name)
Gets the value of a modified attribute.
|
IDfList |
IDfCheckedOutObject.getModifiedAttrs()
Returns a list of attribute names for the attributes that have been
modified while the document is checked out.
|
java.lang.String |
IDfClientRegistry.getProgramDirectory() |
IDfList |
IDfCheckedOutObject.getSharedDocuments()
Returns the list of the object id's of all the documents that share this checked out object
|
java.lang.String |
IDfRegistry.getStringValue(java.lang.String name) |
java.lang.String |
IDfRegistry.getStringValueAt(java.lang.String name,
int index) |
IDfList |
IDfRegistry.getStringValues(java.lang.String name) |
java.lang.String |
IDfClientRegistry.getUserDirectory() |
int |
IDfRegistry.getValuesSize(java.lang.String name) |
IDfViewedObject |
IDfClientRegistry.getViewedObjectById(IDfId objectId)
Finds a viewed file registry object based on object ID
|
IDfViewedObject |
IDfClientRegistry.getViewedObjectByPath(java.lang.String filePath)
Finds a viewed file registry object based on file path
|
IDfList |
IDfClientRegistry.getViewedObjects()
Gets all the viewed objects
|
boolean |
IDfRegistry.isSubKey(java.lang.String subKey) |
boolean |
IDfRegistry.isValueNamePresent(java.lang.String name) |
void |
IDfClientRegistryObject.loadFromRegistry(java.lang.String objId)
Reads the information from the registry into the object
|
void |
IDfClientRegistry.moveToCheckedOutFiles(IDfLocalObject object)
Removes a local file and places it in the list of checked-out files.
|
void |
IDfClientRegistry.moveToLocalFiles(IDfCheckedOutObject object,
IDfSession session)
Removes a checked out file and places it in the list of local files.
|
void |
IDfRegistry.openKey(java.lang.String subKey) |
void |
IDfClientRegistry.removeCheckedOutObject(IDfCheckedOutObject itemToRemove)
Removes a checked-out file object from the registry
|
void |
IDfViewedObject.removeFilePath(java.lang.String filePath)
Removes the file path from the existing viewed object.
|
void |
IDfClientRegistry.removeFileToBeDeleted(java.lang.String filePath)
Removes a file from the list of files to be deleted
|
void |
IDfClientRegistry.removeLocalObject(IDfLocalObject itemToRemove)
Removes a local object from the registry
|
void |
IDfCheckedOutObject.removeSharedDocument(IDfId parentId)
Removes the object id of the document that shares this checked out object.
|
void |
IDfClientRegistry.removeViewedObject(IDfViewedObject itemToRemove)
Removes a viewed object from the registry
|
void |
IDfRegistry.reset() |
void |
IDfRegistry.setBinaryValue(java.lang.String name,
IDfList data) |
void |
IDfRegistry.setBinaryValueAt(java.lang.String name,
int index,
IDfList data) |
void |
IDfRegistry.setBinaryValues(java.lang.String name,
IDfList data) |
void |
IDfClientRegistry.setCheckoutDirectory(java.lang.String checkoutDir)
Sets in the registry the directory where checked out files will be placed
|
void |
IDfClientRegistry.setExportDirectory(java.lang.String exportDir)
Sets in the registry the directory exported files will be written to
|
void |
IDfRegistry.setIntValue(java.lang.String name,
int data) |
void |
IDfRegistry.setIntValueAt(java.lang.String name,
int index,
int data) |
void |
IDfRegistry.setIntValues(java.lang.String name,
IDfList data) |
void |
IDfCheckedOutObject.setMasterObjectId(java.lang.String masterObjectId)
Sets the master object id of the replica or reference object.
|
void |
IDfCheckedOutObject.setModifiedAttr(java.lang.String name,
java.lang.String value)
Marks that an attribute has been changed with the checked-out object.
|
void |
IDfClientRegistry.setProgramDirectory(java.lang.String progDir) |
void |
IDfRegistry.setStringValue(java.lang.String name,
java.lang.String data) |
void |
IDfRegistry.setStringValueAt(java.lang.String name,
int index,
java.lang.String data) |
void |
IDfRegistry.setStringValues(java.lang.String name,
IDfList data) |
void |
IDfClientRegistry.setUserDirectory(java.lang.String userDir)
Sets in the registry the user's directory
|
void |
IDfRegistry.setValuesSize(java.lang.String name,
int size) |
IDfList |
IDfRegistry.subKeys() |
void |
IDfClientRegistryObject.updateRegistry()
Writes the information in the object to the registry
|
IDfList |
IDfRegistry.values() |
Modifier and Type | Method and Description |
---|---|
org.w3c.dom.Document |
IDfXmlQuery.getXMLDOM(org.w3c.dom.Node start)
Returns the XML document as a DOM with the specified
node as root element.
|
java.lang.String |
IDfXmlQuery.getXMLString()
This returns the XML document as a string.
|
java.lang.String |
IDfXmlQuery.getXMLString(org.w3c.dom.Node start)
Returns the XML document as a string with Node as root element.
|
void |
IDfXmlQuery.getXMLString(java.io.OutputStream outputStream)
Returns the result DOM as String and writes it directly into the
provided OutputStream.
|
void |
IDfXmlQuery.getXMLString(java.io.PrintWriter writer)
Returns the result DOM as String and writes it directly into the
provided writer.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfXQuery.close(IDfSession session)
Closes the XQuery results stream.
|
void |
IDfXQuery.execute(IDfSession session)
Executes the XQuery.
|
void |
IDfXQuery.execute(IDfSession session,
com.documentum.xml.xquery.IDfXQueryTargets target)
Executes the XQuery on targets passed in as the parameter.
|
java.lang.String |
IDfXQuery.getCutoffMessage()
Retrieve the cutoff messages from ESS after the query is executed.
|
java.lang.String |
IDfXQuery.getDebugInfo(IDfSession session,
IDfXQuery.FtQueryDebugOptions debugOption)
Retrieve debugging information associated with this query
|
java.lang.String |
IDfXQuery.getExecutionPlan(IDfSession session)
Retrieve the xquery execution plan from ESS after the query is executed.
|
java.lang.String |
IDfXQuery.getOption(IDfXQuery.FtQueryOptions option)
To get the value of the option that was set.
|
void |
IDfXQuery.getXMLFile(java.lang.String filename)
Writes the XQuery results to a file.
|
void |
IDfXQuery.getXMLOutputStream(java.io.OutputStream outputStream)
Writes the XQuery results to an OutputStream object.
|
java.lang.String |
IDfXQuery.getXMLString()
Returns the XQuery results as a Java String object.
|
int |
IDfXQuery.readResults(byte[] buffer)
Fills the given buffer with the next set of XQuery results.
|
int |
IDfXQuery.readResults(byte[] buffer,
IDfSession session)
Fills the given buffer with the next set of XQuery results.
|
void |
IDfXQuery.setBooleanOption(IDfXQuery.FtQueryOptions option,
boolean value)
Set an FtQueryOption to apply to the xquery.
|
void |
IDfXQuery.setIntegerOption(IDfXQuery.FtQueryOptions option,
int value)
Set an FtQueryOption to apply to the xquery.
|
void |
IDfXQuery.setMapOption(IDfXQuery.FtQueryOptions option,
java.util.Map<java.lang.String,java.lang.String> value)
Set an FtQueryOption to apply to the xquery.
|
void |
IDfXQuery.setStringOption(IDfXQuery.FtQueryOptions option,
java.lang.String value)
Set an FtQueryOption to apply to the xquery.
|
Copyright 1994-2023 OpenText Corporation. All rights reserved.