TBOs – Part 6

This is the last post in the TBO series (at least for a while).  I leave you with an easy-access table that lists all of the override-able methods for TBO development.  All of the methods are protected and your overrides should be as well.  This list can be found in the EMC Documentum Foundation Classes Development Guide.  I thought I would reproduce it here because it isn’t always the easiest thing to find, and it isn’t easy to cut-and-paste from either.

IDfSysObject

Return Type Method Name Method Signature
IDfId doAddESignature (String userName, String password, String signatureJustification, String formatToSign, String hashAlgorithm, String preSignatureHash, String signatureMethodName, String applicationProperties, String passThroughArgument1, String passThroughArgument2, Object[] extendedArgs) throws DfException
IDfId doAddReference (IDfId folderId, String bindingCondition, String bindingLabel, Object[] extendedArgs) throws DfException
void doAddRendition (String fileName, String formatName, int pageNumber, String pageModifier, String storageName, boolean atomic, boolean keep, boolean batch, String otherFileName, Object[] extendedArgs) throws DfException
void doAppendFile (String fileName, String otherFileName, Object[] extendedArgs) throws DfException
IDfCollection doAssemble (IDfId virtualDocumentId, int interruptFrequency, String qualification, String nodesortList, Object[] extendedArgs) throws DfException
IDfVirtualDocument doAsVirtualDocument (String lateBindingValue, boolean followRootAssembly, Object[] extendedArgs) throws DfException
void doAttachPolicy (IDfId policyId, String state, String scope, Object[] extendedArgs) throws DfException
void doBindFile ( int pageNumber, IDfId srcId, int srcPageNumber, Object[] extendedArgs) throws DfException
IDfId doBranch (String versionLabel, Object[] extendedArgs) throws DfException
void doCancelScheduledDemote (IDfTime scheduleDate, Object[] extendedArgs) throws DfException
void doCancelScheduledPromote (IDfTime scheduleDate, Object[] extendedArgs) throws DfException
void doCancelScheduledResume (IDfTime schedule, Object[] extendedArgs) throws DfException
void doCancelScheduledSuspend (IDfTime scheduleDate, Object[] extendedArgs) throws DfException
IDfId doCheckin (boolean fRetainLock, String versionLabels, String oldCompoundArchValue, String oldSpecialAppValue, String newCompoundArchValue, String newSpecialAppValue, Object[] extendedArgs) throws DfException
IDfId doCheckout (String versionLabel, String compoundArchValue, String specialAppValue, Object[] extendedArgs) throws DfException
void doDemote (String state, boolean toBase, Object[] extendedArgs) throws DfException
void doDestroyAllVersions (Object[] extendedArgs) throws DfException
void doDetachPolicy (Object[] extendedArgs) throws DfException
void doDisassemble (Object[] extendedArgs) throws DfException
boolean doFetch (String currencyCheckValue, boolean usePersistentCache, boolean useSharedCache, Object[] extendedArgs) throws DfException
void doFreeze (boolean freezeComponents, Object[] extendedArgs) throws DfException
void doInsertFile (String fileName, int pageNumber, String otherFileName, Object[] extendedArgs) throws DfException
void doGrant (String accessorName, int accessorPermit, String extendedPermission, Object[] extendedArgs) throws DfException
void doGrantPermit (IDfPermit permit, Object[] extendedArgs) throws DfException
void doLink (String folderSpec, Object[] extendedArgs) throws DfException
void doLock (Object[] extendedArgs) throws DfException
void doMark (String versionLabels, Object[] extendedArgs) throws DfException
void doPromote (String state, boolean override, boolean fTestOnly, Object[] extendedArgs) throws DfException
void doPrune (boolean keepSLabel, Object[] extendedArgs) throws DfException
IDfId doQueue (String queueOwner, String event, int priority, boolean sendMail, IDfTime dueDate, String message, Object[] extendedArgs) throws DfException
void doRefreshReference (Object[] extendedArgs) throws DfException
void doRegisterEvent (String message, String event, int priority, boolean sendMail, Object[] extendedArgs) throws DfException
void doRemovePart (IDfId containmentId, double orderNo, boolean orderNoFlag, Object[] extendedArgs) throws DfException
void doRemoveRendition (String formatName, int pageNumber, String pageModifier, boolean atomic, Object[] extendedArgs) throws DfException
String doResolveAlias (String scopeAlias, Object[] extendedArgs) throws DfException
void doResume (String state, boolean toBase, boolean override, boolean fTestOnly, Object[] extendedArgs) throws DfException
void doRevert (boolean aclOnly, Object[] extendedArgs) throws DfException
void doRevoke (String accessorName, String extendedPermission, Object[] extendedArgs) throws DfException
void doRevokePermit (IDfPermit permit, Object[] extendedArgs) throws DfException
void doSave (boolean saveLock, String versionLabel, Object[] extendedArgs) throws DfException
IDfId doSaveAsNew (boolean shareContent, boolean copyRelations, Object[] extendedArgs) throws DfException
void doScheduleDemote (String state, IDfTime scheduleDate, Object[] extendedArgs) throws DfException
void doSchedulePromote (String state, IDfTime scheduleDate, boolean override, Object[] extendedArgs) throws DfException
void doScheduleResume (String state, IDfTime scheduleDate, boolean toBase, boolean override, Object[] extendedArgs) throws DfException
void doScheduleSuspend (String state, IDfTime scheduleDate, boolean override, Object[] extendedArgs) throws DfException
void doSetACL (IDfACL acl, Object[] extendedArgs) throws DfException
void doSetFile (String fileName, String formatName, int pageNumber, String otherFile, Object[] extendedArgs) throws DfException
void doSetIsVirtualDocument (boolean treatAsVirtual, Object[] extendedArgs) throws DfException
void doSetPath (String fileName, String formatName, int pageNumber, String otherFile, Object[] extendedArgs) throws DfException
void doSuspend (String state, boolean override, boolean fTestOnly, Object[] extendedArgs) throws DfException
void doUnfreeze (boolean thawComponents, Object[] extendedArgs) throws DfException
void doUnlink (String folderSpec, Object[] extendedArgs) throws DfException
void doUnmark (String versionLabels, Object[] extendedArgs) throws DfException
void doUnRegisterEvent (String event, Object[] extendedArgs) throws DfException
void doUpdatePart (IDfId containmentId, String versionLabel, double orderNumber, boolean useNodeVerLabel, boolean followAssembly, int copyChild, String containType, String containDesc, Object[] extendedArgs) throws DfException
void doUseACL (String aclType, Object[] extendedArgs) throws DfException
void doVerifyESignature (Object[] extendedArgs) throws DfException

Methods of DfPersistentObject

Return Type Method Name Method Signature
IDfRelation doAddChildRelative (String relationTypeName, IDfId childId, String childLabel, boolean isPermanent, String description, Object[] extendedArgs) throws DfException
IDfRelation doAddParentRelative (String relationTypeName, IDfId parentId, String childLabel,
void doDestroy (boolean force, Object[] extendedArgs) throws DfException
void doRemoveChildRelative (String relationTypeName, IDfId childId, String childLabel, Object[] extendedArgs) throws DfException
void doRemoveParentRelative (String relationTypeName, IDfId parentId, String childLabel, Object[]extendedArgs) throws DfException
void doRevert (boolean aclOnly, Object[] extendedArgs) throws DfException
void doSave (boolean saveLock, String versionLabel, Object[] extendedArgs) throws DfException
void doSignoff (String user, String password, String reason, Object[] extendedArgs) throws DfException

Methods of DfTypedObject

Return Type Method Name Method Signature
void doAppendString (String attrName, String value, Object[] extendedArgs) throws DfException
String doGetString (String attrName, int valueIndex, Object[] extendedArgs) throws DfException
void doInsertString (String attrName, int valueIndex, String value, Object[] extendedArgs) throws DfException
void doSetString (String attrName, int valueIndex, String value, Object[] extendedArgs) throws DfException
void doRemove (String attrName, int beginIndex, int endIndex, Object[] extendedArgs) throws DfException

Methods of DfGroup

Return Type Method Name Method Signature
boolean doAddGroup (String groupName, Object[] extendedArgs) throws DfException
boolean doAddUser (String userName, Object[] extendedArgs) throws DfException
void doRemoveAllGroups (Object[] extendedArgs) throws DfException
void doRemoveAllUsers (Object[] extendedArgs) throws DfException
boolean doRemoveGroup (String groupName, Object[] extendedArgs) throws DfException
boolean doRemoveUser (String userName, Object[] extendedArgs) throws DfException
void doRenameGroup (String groupName, boolean isImmediate, boolean unlockObjects, boolean reportOnly, Object[] extendedArgs) throws DfException

Methods of DfUser

Return Type Method Name Method Signature
void doChangeHomeDocbase (String homeDocbase, boolean isImmediate, Object[] extendedArgs) throws DfException
void doRenameUser (String userName, boolean isImmediate, boolean unlockObjects, boolean reportOnly, Object[] extendedArgs) throws DfException
void doSetAliasSet (String aliasSetName, Object[] extendedArgs) throws DfException
void doSetClientCapability (int clientCapability, Object[] extendedArgs) throws DfException
void doSetDefaultACL (String aclName, Object[] extendedArgs) throws DfException
void doSetDefaultFolder (String folderPath, boolean isPrivate, Object[] extendedArgs) throws DfException
void doSetHomeDocbase (String docbaseName, Object[] extendedArgs) throws DfException
void doSetUserOSName (String accountName, String domainName, Object[] extendedArgs) throws DfException
void doSetUserState (int userState, boolean unlockObjects, Object[] extendedArgs) throws DfException
Advertisements

About Scott
I have been implementing Documentum solutions since 1997. In 2005, I published a book about developing Documentum solutions for the Documentum Desktop Client (ISBN 0595339689). In 2010, I began this blog as a record of interesting and (hopefully) helpful bits of information related to Documentum, and as a creative outlet.

One Response to TBOs – Part 6

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: