public interface IDfSysObject extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
IDfId |
addDigitalSignature(java.lang.String userName,
java.lang.String reason)
Create an audit trail entry that records the signing of a DfSysObject by a user.
|
IDfId |
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.
|
void |
addNote(IDfId targetId,
boolean keepPermanent)
Adds an annotation (the current IDfSysObject) to the target object.
|
IDfId |
addReference(IDfId folderId,
java.lang.String bindingCondition,
java.lang.String bindingLabel)
Add a reference to the object in another folder.
|
void |
addRendition(java.lang.String fileName,
java.lang.String formatName)
Adds a new rendition to the object.
|
void |
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 |
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 |
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 |
appendContent(java.io.ByteArrayOutputStream content)
Appends new content to an object.
|
void |
appendContentEx(java.io.ByteArrayOutputStream content,
boolean other)
Appends new content to an object.
|
void |
appendFile(java.lang.String fileName)
Appends new content to an object.
|
void |
appendFileEx(java.lang.String fileName,
java.lang.String otherFileName)
Appends new content to an object.
|
IDfId |
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.
|
boolean |
areAttributesModifiable()
Returns whether this object's attributes can be modified.
|
IDfCollection |
assemble(IDfId virtualDocId,
int interruptFreq,
java.lang.String qualification,
java.lang.String nodesortList)
Creates an assembly and associates it with the object.
|
IDfVirtualDocument |
asVirtualDocument(java.lang.String lateBindingValue,
boolean followRootAssembly)
Returns a virtual document representation of the object.
|
void |
attachPolicy(IDfId policyId,
java.lang.String state,
java.lang.String scope)
Attaches a business policy object to the object.
|
void |
bindFile(int pageNumber,
IDfId srcId,
int srcPageNumber)
Binds content associated with an object to another object.
|
IDfId |
branch(java.lang.String versionLabel)
Creates and checks out a new version of an object.
|
void |
cancelCheckout()
Removes an intention lock without saving any changes that may have been made
to the locked object.
|
void |
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 |
cancelScheduledDemote(IDfTime scheduleDate)
This will cancel the scheduled demote of the sysobject at the date/time
specifed by
scheduleDate . |
void |
cancelScheduledPromote(IDfTime scheduleDate)
This will cancel the scheduled promote for the date/time specified in the
scheduleDate argument. |
void |
cancelScheduledResume(IDfTime schedule)
This will cancel a scheduled resume of the sysobject for a certain date/time.
|
void |
cancelScheduledSuspend(IDfTime scheduleDate)
This method can be used to cancel a scheduled suspend of the sysobject at a
date/time.
|
boolean |
canDemote()
Returns whether the object can be demoted from the current state.
|
boolean |
canPromote()
Returns whether the sysobject can be promoted from
current state to the next state.
|
boolean |
canResume()
Returns whether the sysobject can be resumed from an exception state.
|
boolean |
canSuspend()
Returns whether the sysobject can suspend from its current state to
the exception state.
|
IDfId |
checkin(boolean keepLock,
java.lang.String versionLabels)
Creates a new version of this object and removes the lock
from the previous version.
|
IDfId |
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 |
checkout()
Places a lock on the object.
|
IDfId |
checkoutEx(java.lang.String versionLabel,
java.lang.String compoundArchValue,
java.lang.String specialAppValue)
Places a lock on the object.
|
void |
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 |
destroyAllVersions()
Destroys all versions of the object.
|
void |
detachPolicy()
Detaches an existing business policy object from the object.
|
void |
disassemble()
Disassembles the assembly associated with the object.
|
void |
freeze(boolean freezeComponents)
Marks an object as unchangeable (and optionally its components),
if the object is a virtual document.
|
IDfTime |
getAccessDate()
Returns the date the content of this object was last accessed.
|
java.lang.String |
getAccessorApplicationPermit(int index)
Returns the application permit assigned to a user or group.
|
int |
getAccessorCount()
Returns the number of users or groups for whom some level of access is defined for the object.
|
java.lang.String |
getAccessorName(int index)
Returns the list of users and groups for whom some level of access is defined for the object.
|
java.lang.String |
getAccessorPermit(int index)
Returns the permit levels assigned to each user or group using the computed attribute _accessor_name.
|
int |
getAccessorPermitType(int index)
Returns the permit type assigned to each user or group using the computed attribute _accessor_name.
|
int |
getAccessorXPermit(int index)
Returns the extended permission levels of the specified user or group using the computed attribute
_accessor_name.
|
java.lang.String |
getAccessorXPermitNames(int index)
Retrieves the extended permissions, in upper case and separated by a comma, that are assigned to each user or
group.
|
IDfACL |
getACL()
Returns an ACL associated with the object.
|
java.lang.String |
getACLDomain()
Returns the domain of the ACL associated with this user.
|
java.lang.String |
getACLName()
Returns the name of the associated ACL.
|
boolean |
getAclRefValid()
Indicates whether the values in _accessor_name and _accessor_permit have been saved to the repository using the
computed attribute _acl_ref_valid.
|
IDfEnumeration |
getAcsRequests(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
IDfAcsTransferPreferences transferPreferences)
Returns an
IDfEnumeration object containing a list of IDfAcsRequest objects. |
java.lang.String |
getAliasSet()
Returns the symbolic name of the policy alias set.
|
IDfId |
getAliasSetId()
Returns the position of alias-binding scope specified in the associated policy object.
|
IDfId |
getAntecedentId()
Returns the object id of the object's parent.
|
java.lang.String |
getApplicationType()
Returns the a_application_type attribute of the object.
|
IDfId |
getAssembledFromId()
Returns the object id of the virtual document that was the source of the assembly associated with the object.
|
java.lang.String |
getAuthors(int index)
Returns the authors attribute at the specified index.
|
int |
getAuthorsCount()
Returns the number of values the authors attribute has.
|
int |
getBranchCount()
Returns the number of branches on the version tree that contains the object.
|
IDfId |
getCabinetId()
Returns the object id of the cabinet that is the object's primary storage location.
|
IDfId |
getChronicleId()
Returns the object id of the root object in the version tree.
|
IDfCollection |
getCollectionForContent(java.lang.String format,
int pageNumber)
Returns a collection containing the object's content in the repository.
|
IDfCollection |
getCollectionForContentEx2(java.lang.String format,
int pageNumber,
java.lang.String pageModifier)
Returns a collection containing the object's content in the repository.
|
IDfCollection |
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 |
getCollectionForContentEx4(java.lang.String format,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Returns a collection containing the object's content in the repository.
|
IDfId |
getComponentId(int index)
Returns the chronicle id of the component documents that make up the virtual document using the computed
attribute _componentID.
|
int |
getComponentIdCount()
Returns the number of chronicle IDs of the component documents that make up the virtual document using the
computed attribute _componentID.
|
java.lang.String |
getCompoundArchitecture()
Used by the virtual document manager to determine if the object can be changed.
|
IDfId |
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 |
getContainIdCount()
Returns the number of containment objects IDs that link the component document to its containing virtual document
using the computed attribute _containID.
|
java.io.ByteArrayInputStream |
getContent()
Copies this object's content from the Documentum server into a
ByteArrayInputStream object. |
IDfContentAvailability |
getContentAvailability(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
java.lang.String networkLocationIdentifier)
Returns content availability settings.
|
java.io.ByteArrayInputStream |
getContentEx(java.lang.String format,
int pageNumber)
Copies this object's content in the repository into a
ByteArrayInputStream . |
java.io.ByteArrayInputStream |
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 |
getContentEx3(java.lang.String format,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Copies this object's content in the repository into a
ByteArrayInputStream . |
IDfId |
getContentsId()
Returns the object id of the content object for an object that has only one content.
|
long |
getContentSize()
Returns the number of bytes in the content.
|
long |
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 |
getContentState(int index)
Returns the state of the content for a given sysobject using the computed attribute
_content_state.
|
int |
getContentStateCount()
Returns the number of states of a content for the sysobject using the computed attribute _content_state.
|
java.lang.String |
getContentType()
Returns the file format of the object's content.
|
IDfTime |
getCreationDate()
Returns the r_creation_date attribute of the object.
|
java.lang.String |
getCreatorName()
Returns the name of the creator.
|
int |
getCurrentState()
Returns the current state.
|
java.lang.String |
getCurrentStateName()
Returns the name of the current state.
|
java.lang.String |
getDirectDescendant()
Returns whether the object has any direct descendants (versions derived directly from this object).
|
java.lang.Double |
getDoubleContentAttr(java.lang.String name,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Return a numeric content attribute.
|
java.lang.String |
getExceptionStateName()
Returns the name of the exception state associated
with the current state, if any exist.
|
java.lang.String |
getFile(java.lang.String fileName)
Retrieves a content file from the Documentum server.
|
java.lang.String |
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 |
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.
|
IDfId |
getFolderId(int index)
Returns the object id of the folder linked to this object at the given index.
|
int |
getFolderIdCount()
Returns the number of folders linked to the object.
|
IDfFormat |
getFormat()
Returns the format of the object.
|
int |
getFrozenAssemblyCount()
Returns a count of the number of frozen assemblies that contain the object.
|
boolean |
getFullText()
Returns whether the document is marked for full-text indexing.
|
java.lang.String |
getGroupName()
Returns the group name to which this object belongs.
|
int |
getGroupPermit()
Returns the object-level permission assigned to the group for this object.
|
boolean |
getHasEvents()
Returns whether any users have registered to receive events for the object.
|
boolean |
getHasFolder()
Returns whether this object is the CURRENT object in the version tree.
|
boolean |
getHasFrozenAssembly()
Returns whether the document's assembly is frozen.
|
java.lang.String |
getImplicitVersionLabel()
Returns the implicit version label from r_version_label.
|
java.lang.String |
getKeywords(int index)
Returns the keywords attribute at the specified index.
|
int |
getKeywordsCount()
Returns the number of keywords for the object.
|
boolean |
getLatestFlag()
Indicates whether this version is the most recent version of the object on a particular branch in the version
tree.
|
int |
getLinkCount()
Returns the number of objects linked to the object.
|
int |
getLinkHighCount()
Returns the current maximum order number assigned to a component.
|
IDfCollection |
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 |
getLockDate()
Returns the date this object was locked.
|
java.lang.String |
getLockMachine()
Returns the name of the client machine on which the object was locked.
|
java.lang.String |
getLockOwner()
Returns the name of the user who locked the object.
|
java.lang.String |
getLogEntry()
Returns the comment specified by the user.
|
java.lang.String |
getMasterDocbase()
Returns the repository id of the repository that owns the object using the computed attribute _master_docbase.
|
java.lang.String |
getModifier()
Returns the name of the user who made the last modification.
|
IDfTime |
getModifyDate()
Returns the r_modify_date attribute of the object.
|
java.lang.String |
getNextStateName()
Returns the name of the next state.
|
java.lang.String |
getObjectName()
Returns the object_name attribute of the object.
|
long |
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 |
getOwnerName()
Returns the name of this object's owner.
|
int |
getOwnerPermit()
Returns the object-level permission assigned to the owner of the object.
|
int |
getPageCount()
Returns the number of pages in the primary content.
|
java.lang.String |
getPath(int pageNumber)
Retrieves the content location for an external store object.
|
java.lang.String |
getPathEx(int pageNumber,
java.lang.String pageModifier)
Retrieves the content location for an external store object.
|
java.lang.String |
getPathEx2(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
boolean other)
Retrieves the content location for an external store object.
|
IDfList |
getPermissions()
Returns a list of
DfPermit objects representing all the permissions specified in the ACL for the
sysobject. |
int |
getPermit()
Returns an integer number that corresponds to the access permission level that the current user has for the
object.
|
int |
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.
|
IDfId |
getPolicyId()
Returns the object id of attached business policy object.
|
java.lang.String |
getPolicyName()
Returns the name of attached business policy object.
|
java.lang.String |
getPreviousStateName()
Returns the name of the previous state.
|
int |
getReferenceCount()
Returns the number of folder references made by the object.
|
IDfId |
getRemoteId()
Returns the object id of the remote object.
|
IDfCollection |
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.
|
java.lang.String |
getResolutionLabel()
Returns the default version label used to resolve late-bound nodes of a virtual document.
|
int |
getResumeState()
Returns the resume state.
|
java.lang.String |
getResumeStateName()
Returns the resume state name.
|
int |
getRetainerCount()
Return the number of retainers on this object.
|
IDfId |
getRetainerId(int index)
Return the id of the requested retainer.
|
IDfTime |
getRetainUntilDate()
Returns the retain until date for this object.
|
IDfTime |
getRetentionDate()
Used internally.
|
IDfCollection |
getRouters(java.lang.String additionalAttributes,
java.lang.String orderBy)
Returns a collection of routers the document participates in.
|
java.lang.String |
getSpecialApp()
Reserved for use by Documentum products.
|
java.lang.String |
getStatus()
Returns the a_status attribute of the object.
|
java.lang.String |
getStorageType()
Returns the default storage area for content files associated with the object.
|
java.lang.String |
getStringContentAttr(java.lang.String name,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Return a string content attribute.
|
java.lang.String |
getSubject()
Returns the subject attribute of the object.
|
IDfTime |
getTimeContentAttr(java.lang.String name,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Return a time content attribute.
|
java.lang.String |
getTitle()
Returns the title attribute of the object.
|
java.lang.String |
getTypeName()
Returns the r_object_type attribute of the object.
|
IDfCollection |
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 |
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.
|
java.lang.String |
getVersionLabel(int index)
Returns the version label at the specified index.
|
int |
getVersionLabelCount()
Returns the number of version labels.
|
IDfVersionLabels |
getVersionLabels()
Returns an IDfVersionLabels object associated with this sysobject.
|
IDfVersionPolicy |
getVersionPolicy()
This will extract all the version labels associated with this object
and return the results as an IDfVersionPolicy interface.
|
IDfCollection |
getVersions(java.lang.String attrNames)
Runs a query to find all the versions of the object and returns the
query results as a collection.
|
IDfCollection |
getWorkflows(java.lang.String additionalAttributes,
java.lang.String orderBy)
Returns a collection of workflows the document currently participates in.
|
int |
getWorldPermit()
Returns the object-level permission assigned to the world for the object.
|
int |
getXPermit(java.lang.String accessorName)
Returns the extended permissions, in integer form, for a specified user or group using the computed attribute
_xpermit.
|
java.lang.String |
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 |
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.
|
void |
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 |
grantPermit(IDfPermit permit)
Creates an access control entry in this object, assigning
an access level to a specified user or group.
|
boolean |
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.
|
void |
insertContent(java.io.ByteArrayOutputStream content,
int pageNumber)
Inserts new content into an object.
|
void |
insertContentEx(java.io.ByteArrayOutputStream content,
int pageNumber,
boolean other)
Inserts new content into an object.
|
void |
insertFile(java.lang.String fileName,
int pageNumber)
Inserts a new content file into an object.
|
void |
insertFileEx(java.lang.String fileName,
int pageNumber,
java.lang.String otherFileName)
Inserts a new content file into an object.
|
IDfId |
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.
|
boolean |
isArchived()
Returns the a_archive attribute of the object.
|
boolean |
isCheckedOut()
Returns whether this object is checked out.
|
boolean |
isCheckedOutBy(java.lang.String userName)
Returns whether this object is checked out by the specified user.
|
boolean |
isContentTransferCapabilityEnabled(java.lang.String networkLocationIdentifier,
IDfContentTransferCapability capability)
Returns whether content transfer capability is enabled for the object
|
boolean |
isFrozen()
Returns whether this object was specifically frozen and is now unchangeable.
|
boolean |
isHidden()
Indicates if this object is visible to the end users.
|
boolean |
isImmutable()
Returns whether this object can be changed.
|
boolean |
isLinkResolved()
Returns the a_link_resolved attribute of the object.
|
boolean |
isPublic()
Returns whether the object is public or not.
|
boolean |
isReference()
Returns whether the object is a reference object.
|
boolean |
isSuspended()
Return whether the object is in a suspended state.
|
boolean |
isVirtualDocument()
Returns true if this document should be treated as a virtual document.
|
void |
link(java.lang.String folderSpec)
Associates the object with a folder or cabinet.
|
void |
mark(java.lang.String versionLabels)
Assigns one or more symbolic version labels to an object.
|
void |
mount(java.lang.String path)
Deprecated.
|
java.lang.String |
print(java.lang.String printer,
boolean printCover,
boolean saveOutput,
int numCopies,
int startingContentPage,
int endingContentPage)
Prints the object.
|
void |
promote(java.lang.String state,
boolean override,
boolean fTestOnly)
Promotes the sysobject to the state specified in the
state
argument. |
void |
prune(boolean keepLabels)
Removes unwanted versions of an object.
|
IDfId |
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 |
refreshReference()
Refreshes the reference object.
|
void |
removeContent(int pageNumber)
Deletes content from an object.
|
void |
removeNote(IDfId annotationId)
Deprecated.
|
void |
removePart(IDfId containmentId,
double orderNo,
boolean orderNoFlag)
Removes a virtual document child from the object.
|
void |
removeRendition(java.lang.String formatName)
Deletes a rendition from the object.
|
void |
removeRenditionEx(java.lang.String formatName,
int pageNumber,
boolean atomic)
Deletes a rendition from the object.
|
void |
removeRenditionEx2(java.lang.String formatName,
int pageNumber,
java.lang.String pageModifier,
boolean atomic)
Deletes a rendition from the object.
|
java.lang.String |
resolveAlias(java.lang.String scopeAlias)
Searches an alias set for a specified alias.
|
void |
resume(java.lang.String state,
boolean toBase,
boolean override,
boolean fTestOnly)
Resumes the sysobject from an exception state.
|
void |
revertACL()
Throws away unsaved permission changes.
|
void |
revoke(java.lang.String accessorName,
java.lang.String extendedPermission)
Removes all access control entries from this object for a
specified user or group.
|
void |
revokePermit(IDfPermit permit)
Removes specified permit from the sysobject.
|
IDfId |
saveAsNew(boolean shareContent)
Copies an object.
|
void |
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 |
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 |
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 |
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 |
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 |
setACL(IDfACL acl)
Assigns an ACL object to the object.
|
void |
setACLDomain(java.lang.String aclDomain)
Sets the domain of the ACL associated with this user.
|
void |
setACLName(java.lang.String ACLName)
Sets the name of the associated ACL.
|
void |
setApplicationType(java.lang.String type)
Sets the a_application_type attribute of the object.
|
void |
setArchived(boolean archived)
Sets the a_archive attribute of the object.
|
void |
setAuthors(int index,
java.lang.String author)
Sets the authors attribute at a specified index.
|
void |
setCompoundArchitecture(java.lang.String compoundArchitecture)
Used by the virtual document manager to determine if the object can be changed.
|
boolean |
setContent(java.io.ByteArrayOutputStream content)
Sets new content to an object.
|
boolean |
setContentEx(java.io.ByteArrayOutputStream content,
java.lang.String format,
int pageNumber)
This is the extended method for setting the content of an object.
|
boolean |
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 |
setContentType(java.lang.String contentType)
Sets the file format of the object's content.
|
void |
setDoubleContentAttribute(java.lang.String name,
double value,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Set a numeric content attribute.
|
void |
setFile(java.lang.String fileName)
Sets the content file of this object or replaces an existing content.
|
void |
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 |
setFullText(boolean fullText)
Sets whether the document is marked for full-text indexing.
|
void |
setGroupName(java.lang.String name)
Set the group name to which this object belongs.
|
void |
setGroupPermit(int permit)
Sets the object-level group permission for the object.
|
void |
setHidden(boolean isHidden)
Sets the visibility of the object for end users.
|
void |
setIsVirtualDocument(boolean is_virtual_doc)
Sets the r_is_virtual_doc attribute for the object.
|
void |
setKeywords(int index,
java.lang.String keyword)
Sets the keywords attribute at a specified index.
|
void |
setLinkResolved(boolean linkResolved)
Sets the a_link_resolved attribute of the object.
|
void |
setLogEntry(java.lang.String logEntry)
Sets the comment specified by the user.
|
void |
setObjectName(java.lang.String objectName)
Sets the object_name attribute of the object.
|
void |
setOwnerName(java.lang.String ownerName)
Sets the name of the object's owner.
|
void |
setOwnerPermit(int permit)
Assigns the object-level permission to the owner of the object.
|
void |
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 |
setResolutionLabel(java.lang.String label)
Sets the resolution label for the object.
|
void |
setSpecialApp(java.lang.String specialApp)
Reserved for use by Documentum products.
|
void |
setStatus(java.lang.String status)
Sets the a_status attribute of the object.
|
void |
setStorageType(java.lang.String type)
Sets the storage area for content files associated with the object.
|
void |
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 |
setSubject(java.lang.String subject)
Sets the subject attribute of the object.
|
void |
setTimeContentAttribute(java.lang.String name,
IDfTime value,
java.lang.String formatName,
int page,
java.lang.String pageModifier)
Set a Date/Time content attribute.
|
void |
setTitle(java.lang.String title)
Sets the title attribute of the object.
|
void |
setWorldPermit(int permit)
Sets the object-level permission assigned to the world for the object.
|
void |
suspend(java.lang.String state,
boolean override,
boolean fTestOnly)
Suspends the sysobject from its current state to the exception
state.
|
void |
unfreeze(boolean thawComponents)
Unfreezes a frozen object, and optionally if the object is a
virtual document, it unfreezes the object's associated assembly.
|
void |
unlink(java.lang.String folderSpec)
Removes a link between the object and a folder or cabinet.
|
void |
unmark(java.lang.String versionLabels)
Removes symbolic labels from an object.
|
void |
updatePart(IDfId containmentId,
java.lang.String versionLabel,
double orderNumber,
boolean useNodeVerLabel,
boolean followAssembly,
int copyChild)
Modifies a child dmr_containment attribute value.
|
void |
updatePartEx(IDfId containmentId,
java.lang.String versionLabel,
double orderNumber,
boolean useNodeVerLabel,
boolean followAssembly,
int copyChild,
java.lang.String containType,
java.lang.String containDesc) |
void |
useACL(java.lang.String aclType)
Assigns an ACL specification to the object.
|
void |
verifyESignature()
Verify the signature on an electronically signed sysobject.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
IDfId saveAsNew(boolean shareContent) throws DfException
shareContent
- Determines if the content of this
object is shared with the new object.DfException
- if a server error occurs.boolean areAttributesModifiable() throws DfException
DfException
- if a server error occurs.boolean isImmutable() throws DfException
DfException
- if a server error occurs.boolean isPublic() throws DfException
true
if the object is public.DfException
- if a server error occurs.java.lang.String getObjectName() throws DfException
DfException
void setObjectName(java.lang.String objectName) throws DfException
objectName
- specifies the name of the object.DfException
- if a server error occurs.java.lang.String getTypeName() throws DfException
DfException
java.lang.String getTitle() throws DfException
DfException
void setTitle(java.lang.String title) throws DfException
title
- specifies the title of the objectDfException
- if a server error occursjava.lang.String getSubject() throws DfException
DfException
void setSubject(java.lang.String subject) throws DfException
subject
- specifies the subject of the object.DfException
- if a server error occurs.int getAuthorsCount() throws DfException
DfException
- if a server error occurs.java.lang.String getAuthors(int index) throws DfException
index
- specifies the index at which the author is placed.DfException
- if a server error occurs.void setAuthors(int index, java.lang.String author) throws DfException
index
- specifies the index at which the author is placedauthor
- specifies the author at the specified indexDfException
- if a server error occurs.int getKeywordsCount() throws DfException
DfException
- if a server error occurs.java.lang.String getKeywords(int index) throws DfException
DfException
- if a server error occurs.void setKeywords(int index, java.lang.String keyword) throws DfException
index
- specifies the index at which the keyword is placed.keyword
- specifies the keyword at the specified index.DfException
- if a server error occurs.java.lang.String getApplicationType() throws DfException
DfException
- if a server error occurs.void setApplicationType(java.lang.String type) throws DfException
type
- specifies the application type.DfException
- if a server error occurs.java.lang.String getSpecialApp() throws DfException
DfException
- if a server error occurs.void setSpecialApp(java.lang.String specialApp) throws DfException
specialApp
- specifies the special application information.DfException
- if a server error occurs.boolean isHidden() throws DfException
DfException
- if a server error occurs.void setHidden(boolean isHidden) throws DfException
isHidden
- specifies the visibility of the object for end users.DfException
- if a server error occurs.java.lang.String getStatus() throws DfException
DfException
- if a server error occurs.void setStatus(java.lang.String status) throws DfException
status
- specifies status.DfException
- if a server error occurs.IDfTime getCreationDate() throws DfException
DfException
- if a server error occurs.IDfTime getAccessDate() throws DfException
DfException
- if a server error occurs.IDfTime getModifyDate() throws DfException
DfException
- if a server error occurs.java.lang.String getModifier() throws DfException
DfException
- if a server error occurs.IDfTime getRetentionDate() throws DfException
DfException
- if a server error occurs.boolean isArchived() throws DfException
DfException
- if a server error occurs.void setArchived(boolean archived) throws DfException
archived
- specifies the object has been archived.DfException
- if a server error occurs.boolean getFullText() throws DfException
DfException
- if a server error occurs.void setFullText(boolean fullText) throws DfException
fullText
- specifies whether the document is marked for full-text indexing.DfException
- if a server error occurs.java.lang.String getLogEntry() throws DfException
DfException
- if a server error occurs.void setLogEntry(java.lang.String logEntry) throws DfException
logEntry
- specifies the user-defined commentDfException
- if a server error occurs.void saveLock() throws DfException
DfException
- if a server error occurs.java.lang.String getLockOwner() throws DfException
DfException
- if a server error occurs.IDfTime getLockDate() throws DfException
DfException
- if a server error occurs.java.lang.String getLockMachine() throws DfException
DfException
- if a server error occurs.IDfId getAntecedentId() throws DfException
DfException
- if a server error occurs.IDfId getChronicleId() throws DfException
DfException
- if a server error occurs.IDfCollection getVersions(java.lang.String attrNames) throws DfException
attrNames
parameter is used
to specify the "select" portion of the query. If attrNames
is null
, the following default attributes are used:
r_version_label, r_modify_date, r_modifier, log_entry, object_name,
r_object_type, a_content_type, r_lock_owner, r_link_cnt, r_object_id.null
value for attrNames,
the query may fail if:distinct_query_results
flag has been set to true
in the server.ini file of the underlying repository. (See the Content
Server Administrator's Guide for more details on the server.ini.)distinct_query_results
flag is false,
so this is not normally a problem. However, if you are overriding
the default set of attributes, it is recommended that you
include the attributes r_modify_date and r_object_id so that the code
is portable across docbases regardless of how they are configured.attrNames
- specifies a comma-delimited list of the desired attributes.
If set to null
, the query uses a default set of attributes.DfException
- if attrNames
is invalid.IDfVersionPolicy getVersionPolicy() throws DfException
DfException
- if a server error occurs.boolean getLatestFlag() throws DfException
DfException
- if a server error occurs.java.lang.String getImplicitVersionLabel() throws DfException
DfException
- if a server error occursvoid mark(java.lang.String versionLabels) throws DfException
Before you can use the mark
method, you must
checkout
the specified object. After you execute the
mark
method, you must checkin
or
save
the object to keep the new label or labels.
Note: If the object is a virtual document, you must use checkin
the
the object; you cannot use save
to make the changes effective.
The following code example demonstrates how to create a document and assign a symbolic version label. Assuming the prior version label is "1.0,CURRENT", the code below will set it to "1.1,APPROVED,CURRENT":
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); if (!sysObj.isCheckedOut()) { sysObj.checkout(); } sysObj.mark("APPROVED"); sysObj.checkin (false, "");
versionLabels
- defines the label that you want
to assign to the object. You can specify
one implicit label and/or one or more
symbolic labels.DfException
- if a server error occurs.unmark(java.lang.String)
void unmark(java.lang.String versionLabels) throws DfException
versionLabels
- Defines the label that you want
to remove from the object. You can specify
one implicit label and/or one or more
symbolic labels.DfException
- if a server error occurs.IDfVersionLabels getVersionLabels() throws DfException
DfException
- if failed to create a new DfVersionLabels object
or if a server error occurs.int getVersionLabelCount() throws DfException
DfException
- if a server error occursjava.lang.String getVersionLabel(int index) throws DfException
DfException
- if a server error occurs.IDfId branch(java.lang.String versionLabel) throws DfException
versionLabel
- specifies the object version from which you
want to branch.DfException
- if a server error occurs.int getBranchCount() throws DfException
DfException
- if a server error occurs.java.lang.String getDirectDescendant() throws DfException
DfException
- if a server error occurs.void checkout() throws DfException
The user executing the method must have at least Version permission on the object
being checked out.
Executing checkout
sets the r_lock_machine attribute for the
checked out object. This attribute records the machine name of the client
machine on which the user is working.
The following code example demonstrates how to checkout an object and copy the file from the Documentum server to the local drive (current working directory):
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); if (!sysObj.isCheckedOut()) { sysObj.checkout(); sysObj.getFile(sysObj.getObjectName()); }
DfException
- if a server error occurs.checkin(boolean, java.lang.String)
,
cancelCheckout()
,
getFile(java.lang.String)
IDfId checkoutEx(java.lang.String versionLabel, java.lang.String compoundArchValue, java.lang.String specialAppValue) throws DfException
The user executing the method must have at least Version permission on the object being checked out.
The methods checks out the version specified in the versionLabel argument. If that version is not found, the method fails. The compoundArchValue sets the a_compound_architecture attribute. Setting the attribute to a value other than an empty string affects the behavior of the Virtual Document Manager when this object is opened in VDM. If the attribute is set to any value other than an empty string, VDM assumes that the object is readonly and will not allow structural changes on the object.
The specialAppvalue argument sets the a_special_app attribute of the object. Setting the attribute to a value other than an empty string affects how Content Server and some EMC Documentum clients perceive the object. If there is any value other than an empty string in a_special_app, the system assumes that another application currently has control of the object.
versionLabel
- Identifies the version of the object.
This can be an implicit or symbolic version label.compoundArchValue
- Sets the a_compound_architecture attribute of
the object. The attribute is a string attribute
with a length of 16.specialAppValue
- Sets the a_special_app attribute of the object. The attribute is a string
attribute with a length of 32.DfException
- if a server error occurs.void cancelCheckout() throws DfException
Executing cancelCheckout
clears the object's r_lock_machine
attribute (when an object is checked out, this attribute is set to the name of
the client machine on which the user who locked the object was working).
Performs a DMCL "unlock".
The following code example demonstrates how to cancel a checked out object:
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); if (sysObj.isCheckedOut()) { sysObj.cancelCheckout(); }
DfException
- if a server error occurs.checkout()
,
checkoutEx(java.lang.String, java.lang.String, java.lang.String)
void cancelCheckoutEx(boolean sendMail, java.lang.String compoundValue, java.lang.String specialValue) throws DfException
sendMail
- Directs the server to send electronic mail to the lock
owner, notifying the user that the lock is being removed.compoundValue
- Sets the a_compound_architecture attribute of the object.specialValue
- Sets the a_special_app attribute of the object.DfException
- if a server error occurs.IDfId checkin(boolean keepLock, java.lang.String versionLabels) throws DfException
To use the checkin
method, the following conditions must be met:
The checkin
method unlocks an object and saves any changes
you may have made to either its attributes or its content. (Note that to
make changes to the content, you must issue explicit methods, such as getFile
and setFile
, to get and set the content after you checkout
the object
and before you issue the checkin
).
Executing this method clears the object's r_lock_machine, r_lock_owner, and r_lock_date attributes and sets the a_archive attribute to FALSE. Additionally, if the object is a policy object, the method sets the r_definition_state to DRAFT for the new version and clones the following attributes:
The following code example demonstrates how to checkin an object using the default version labels, and to not retain a lock on the newly created version:
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); if (sysObj.isCheckedOut()) { sysObj.setFile(sysObj.getObjectName()); IDfId newSysObjId = sysObj.checkin(false, ""); }
keepLock
- set to true
to place a lock on the
newly created version.versionLabels
- defines the version label for the new version.
You can specify more than one label. If you do
not define a label, the server automatically gives
the new version an implicit version label and the
symbolic label "CURRENT".DfException
- if a server error occurs.checkout()
,
checkoutEx(java.lang.String, java.lang.String, java.lang.String)
,
getFile(java.lang.String)
,
setFile(java.lang.String)
IDfId checkinEx(boolean keepLock, java.lang.String versionLabels, java.lang.String oldCompoundArchValue, java.lang.String oldSpecialAppValue, java.lang.String newCompoundArchValue, java.lang.String newSpecialAppValue) throws DfException
Note: This method differs from checkin
by providing arguments to set
application-specific attributes.
To use the checkinEx
method, the following conditions must be met:
The checkin
method unlocks an object and saves any changes
you may have made to either its attributes or its content. (Note that to
make changes to the content, you must issue explicit methods, such as getFile
and setFile
, to get and set the content after you checkout
the object
and before you issue the checkinEx
).
Executing this method clears the object's r_lock_machine, r_lock_owner, and r_lock_date attributes and sets the a_archive attribute to FALSE. Additionally, if the object is a policy object, the method sets the r_definition_state to DRAFT for the new version and clones the following attributes:
The oldCompoundArchValue and newCompoundArchValue arguments allow you to set the a_compound_architecture attribute of the object you are checking in and new version of the object. Setting the attribute to a value other than an empty string affects the behavior of the Virtual Document Manager when the object is opened in the VDM. If the attribute is set to any value other than an empty string, VDM assumes that the object is readonly and will not allow structural changes on the object.
The oldSpecialAppvalue and newSpecialAppvalue arguments set the a_special_app attribute of the object you are checking in and the new version of the object. Setting the attribute to a value other than an empty string affects how Content Server and some EMC Documentum clients perceive the object. If there is any value other than an empty string in a_special_app, the system assumes that another application currently has control of the object.
keepLock
- Determines whether a lock is placed on the newly
created version.versionLabels
- Defines the version label for the new version.
You can specify more than one label. If you do
not define a label, the server automatically gives
the new version an implicit version label and the
symbolic label CURRENT.oldCompoundArchValue
- Sets the a_compound_architecture attribute
of the checked-out object.oldSpecialAppValue
- Sets the a_special_app attribute of the
checked-out object.newCompoundArchValue
- Sets the a_compound_architecture attribute
of the new version created by the check in.newSpecialAppValue
- Sets the a_special_app attribute of
the new version created by the checkin.DfException
- if a server error occurs.boolean isCheckedOut() throws DfException
true
if this object is checked out.DfException
- if a server error occurs.boolean isCheckedOutBy(java.lang.String userName) throws DfException
userName
is null or an empty string, the
user name from the current session is used.userName
- identifies the name the user.true
if this object is checked out by the specified user.DfException
- if a server error occurs.void prune(boolean keepLabels) throws DfException
DfException
- if a server error occurs.void destroyAllVersions() throws DfException
DfException
- if a server error occurs.int getReferenceCount() throws DfException
DfException
- if a server error occurs.boolean getHasFolder() throws DfException
DfException
- if a server error occurs.int getFolderIdCount() throws DfException
DfException
- if a server error occurs.IDfId getFolderId(int index) throws DfException
DfException
- if a server error occurs.IDfId getCabinetId() throws DfException
DfException
- if a server error occurs.void link(java.lang.String folderSpec) throws DfException
The first execution of link
for an object defines the object's primary link, the place where
the object is stored in the repository. Subsequent executions link the object to other folders
or cabinets. These are called secondary links.
Executing link
has the following permission requirements:
link
against a cabinet object. That is, cabinets cannot be linked to folders
or other cabinets.
A link
operation is not committed until a save
or checkin
is performed.The following code example demonstrates how to create a document and link it to a specific cabinet and folder:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); sysObj.setFile("c:\\dfc101.txt"); sysObj.link("/DFCObjCab/DFCObjFolder"); sysObj.save();
folderSpec
- Defines the folder or cabinet to which you
want to link the object. You can use either the folder or
cabinet's object ID or its folder path.DfException
- if a server error occurs.unlink(java.lang.String)
void unlink(java.lang.String folderSpec) throws DfException
Executing unlink
has the following permission requirements:
When you unlink an object, the entry in the attribute for the specified folder or cabinet is removed and the entries in subsequent index positions are shifted up one position.
Documents and folders must have at least one link to a folder or cabinet. Consequently, if you
unlink
an object from its only link, you must relink
it to some folder or cabinet before saving or checking in the object.
This operation is not committed until a save
or a
checkin
is performed.
The following code example demonstrates how unlink an object from a
source cabinet and relink it to a target cabinet:
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); sysObj.unlink("/DFCSourceCab"); sysObj.link("/DFCTargetCab"); sysObj.save();
folderSpec
- Defines the folder or cabinet from which you
want to unlink the object. You can use either the folder or
cabinet's object ID or its folder path.DfException
- if a server error occurs.link(java.lang.String)
IDfCollection getLocations(java.lang.String attrNames) throws DfException
attrNames
are used to
specify the "select" portion of the query. Results are sorted
by the first element in attrNames
.attrNames
- specifies the desired attributes.DfException
- if attrNames are invalid.java.lang.String getCreatorName() throws DfException
DfException
- if a server error occurs.java.lang.String getOwnerName() throws DfException
DfException
- if a server error occurs.void setOwnerName(java.lang.String ownerName) throws DfException
ownerName
- specifies the name of the object's owner.DfException
- if a server error occurs.int getOwnerPermit() throws DfException
DfException
- if a server error occurs.void setOwnerPermit(int permit) throws DfException
permit
- specifies the object-level permission to the owner of the object.DfException
- if a server error occurs.java.lang.String getGroupName() throws DfException
DfException
- if a server error occurs.void setGroupName(java.lang.String name) throws DfException
name
- specifies the group name to which this object belongs.DfException
- if a server error occurs.int getGroupPermit() throws DfException
DfException
- if a server error occurs.void setGroupPermit(int permit) throws DfException
permit
- specifies the object-level group permission to set.DfException
- if a server error occurs.int getWorldPermit() throws DfException
DfException
- if a server error occurs.void setWorldPermit(int permit) throws DfException
permit
- specifies the object-level permission assigned to the world for the object.DfException
- if a server error occurs.int getPermit() throws DfException
DfException
- if a server error occurs.IDfACL.DF_PERMIT_BROWSE
,
getPermitEx(java.lang.String)
int getPermitEx(java.lang.String accessorName) throws DfException
accessorName
- specifies the name of the user or group. If not specified, it will be the connected user.DfException
- if a server error occurs.IDfACL.DF_PERMIT_BROWSE
,
getPermit()
int getAccessorCount() throws DfException
DfException
- if a server error occurs.java.lang.String getAccessorName(int index) throws DfException
index
- specifies the index of the user or groupDfException
- if a server error occurs.int getAccessorPermitType(int index) throws DfException
index
- specifies the index of the user or group.DfException
- if a server error occurs.java.lang.String getAccessorPermit(int index) throws DfException
index
- specifies the index of the user or group.DfException
- if a server error occurs.int getXPermit(java.lang.String accessorName) throws DfException
DfException
- if a server error occurs.int getAccessorXPermit(int index) throws DfException
index
- specifies the index of the user or group.DfException
- if a server error occurs.java.lang.String getAccessorXPermitNames(int index) throws DfException
DfException
- if a server error occurs.java.lang.String getAccessorApplicationPermit(int index) throws DfException
index
- the index position of the user or group among the ACL's accessorsDfException
- if a server error occursgetAccessorCount()
boolean hasPermission(java.lang.String permission, java.lang.String accessorName) throws DfException
permission
- specifies the permission name.accessorName
- specifies the name of the user or group
to whom you are assigning the access level.true
if the specified user or group has the permission.DfException
- if a server error occurs.java.lang.String getXPermitNames(java.lang.String accessorName) throws DfException
accessorName
is not specified, the default will be the session user.DfException
- if a server error occurs.java.lang.String getXPermitList() throws DfException
DfException
- if a server error occurs.void grant(java.lang.String accessorName, int accessorPermit, java.lang.String extendedPermission) throws DfException
save
or a
checkin
.
Performs a DMCL "grant".accessorName
- specifies the name of the user or group
to whom you are assigning the access level.accessorPermit
- the integer corresponding to the basic privilege level
that you want to grant. You can pass 0 if you just wanted to change the extended permission
and leave the basic permission the same.extendedPermission
- the extended permission that you want to grant;
If you do not want to grant an extended permission, specify
null
for this parameterDfException
- if a server error occurs.void grantPermit(IDfPermit permit) throws DfException
save
or a
checkin
.
Performs a DMCL "grant".permit
- Describes the permit being added.DfException
- if a server error occurs.void revoke(java.lang.String accessorName, java.lang.String extendedPermission) throws DfException
save
or a
checkin
.
Performs a DMCL "revoke".accessorName
- specifies the name of the user or group
to whom you are removing the access level.extendedPermission
- defines the extended permission names;
can be null
if no extended permissions.DfException
- if a server error occurs.void revokePermit(IDfPermit permit) throws DfException
save
or a
checkin
.
Performs a DMCL "revoke".permit
- Describes the permit being removed.DfException
- if a server error occurs.IDfList getPermissions() throws DfException
DfPermit
objects representing all the permissions specified in the ACL for the
sysobject.DfException
- if a server error occursIDfACL getACL() throws DfException
getACLName
and getACLDomain
.DfException
- if a server error occurs.void setACL(IDfACL acl) throws DfException
An ACL is assigned to an object when it is created. The ACL
can remain with the object for the life of the object, or you
can replace the ACL with a call to setACL
.
The following code example demonstrates how to assign a private ACL to an object, then reset the object back to the original ACL settings:
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); IDfACL oldACL = sysObj.getACL(); IDfACL newACL = sess.getACL(sess.getLoginUserName(), "MyPrivateACL"); sysObj.setACL(newACL); sysObj.save(); sysObj.setACL(oldACL); sysObj.save();
acl
- the ACL object to assign to the sysobject.DfException
- if a server error occurs.getACL()
void useACL(java.lang.String aclType) throws DfException
aclType
- Specifies which ACL you want to use for this
object. The ACL is specified using a keyword.
Valid key words are:
FOLDER The ACL associated with the object's primary folder TYPE The ACL associated with the object's type definition USER The ACL associated with the dm_user object representing the creator of the object NONE No default ACL
DfException
- if a server error occurs.void revertACL() throws DfException
DfException
- if a server error occurs.java.lang.String getACLName() throws DfException
DfException
- if a server error occurs.void setACLName(java.lang.String ACLName) throws DfException
ACLName
- specifies the name of the associated ACL.DfException
- if a server error occurs.java.lang.String getACLDomain() throws DfException
DfException
- if a server error occurs.void setACLDomain(java.lang.String aclDomain) throws DfException
aclDomain
- specifies the domain of the ACL associated with this user.DfException
- if a server error occurs.boolean getAclRefValid() throws DfException
DfException
- if server occurs an error.IDfId getContentsId() throws DfException
DfException
- if a server error occurs.java.lang.String getContentType() throws DfException
DfException
- if a server error occurs.void setContentType(java.lang.String contentType) throws DfException
Use any file format recognized by the Documentum server. Document format types can be obtained by querying the dm_format object (i.e. select name from dm_format).
The following code example demonstrates how to create a document with a "text" file format:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); sysObj.setFile("c:\\textdoc.txt"); sysObj.save();
contentType
- specifies the file format of the object's content.DfException
- if a server error occurs.IDfFormat getFormat() throws DfException
DfException
- if a server error occurs.int getPageCount() throws DfException
DfException
- if a server error occurs.long getContentSize() throws DfException
DfException
- if a server error occurs.java.lang.String getStorageType() throws DfException
DfException
- if a server error occurs.void setStorageType(java.lang.String type) throws DfException
type
- specifies the storage area for the content files associated with the object.DfException
- if a server error occurs.int getContentStateCount() throws DfException
0 Available and online 1 Archived 2 Offline 3 Error fetching content from repository
DfException
- if a server error occurs.int getContentState(int index) throws DfException
0 Available and online 1 Archived 2 Offline 3 Error fetching content from repository
index
- specifies the position of the sysobject.DfException
- if a server error occurs.IDfCollection getCollectionForContent(java.lang.String format, int pageNumber) throws DfException
IDfContentCollection
or call getCollectionForContentEx4.format
- specifies the format in which you want the content.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.IDfCollection getCollectionForContentEx2(java.lang.String format, int pageNumber, java.lang.String pageModifier) throws DfException
IDfContentCollection
or call getCollectionForContentEx4.format
- specifies the format in which you want the content.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.DfException
IDfCollection getCollectionForContentEx3(java.lang.String format, int pageNumber, java.lang.String pageModifier, boolean other) throws DfException
IDfContentCollection
or call getCollectionForContentEx4.format
- specifies the format in which you want the content.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.other
- for files created on Macintosh systems, indicates
whether you want to retrieve the data fork (the file containing the
content) or the resource fork. If true
, the resource
fork is returned. If false
, the data fork is returned.
The default is false
.DfException
IDfContentCollection getCollectionForContentEx4(java.lang.String format, int pageNumber, java.lang.String pageModifier, boolean other) throws DfException
format
- specifies the format in which you want the content.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.other
- for files created on Macintosh systems, indicates
whether you want to retrieve the data fork (the file containing the
content) or the resource fork. If true
, the resource
fork is returned. If false
, the data fork is returned.
The default is false
.DfException
java.io.ByteArrayInputStream getContent() throws DfException
ByteArrayInputStream
object.
The following code example demonstrates how to copy an objects content from the Documentum server into memory:
IDfSysObject sysObj = (IDfSysObject)session.getObject(new DfId("0900d5bb8001f900")); ByteArrayInputStream bais = sysObj.getContent(); if (bais.available() > 0) { // Data successfully fetched from the server... }
DfException
- if a server error occurs.getContentEx(java.lang.String, int)
,
getContentEx2(java.lang.String, int, java.lang.String)
,
getContentEx3(java.lang.String, int, java.lang.String, boolean)
java.io.ByteArrayInputStream getContentEx(java.lang.String format, int pageNumber) throws DfException
ByteArrayInputStream
.format
- specifies the format in which you want the content.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.java.io.ByteArrayInputStream getContentEx2(java.lang.String format, int pageNumber, java.lang.String pageModifier) throws DfException
ByteArrayInputStream
.format
- specifies the format in which you want the content.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.DfException
java.io.ByteArrayInputStream getContentEx3(java.lang.String format, int pageNumber, java.lang.String pageModifier, boolean other) throws DfException
ByteArrayInputStream
.format
- specifies the format in which you want the content.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.other
- for files created on Macintosh systems, indicates
whether you want to retrieve the data fork (the file containing the
content) or the resource fork. If true
, the resource
fork is returned. If false
, the data fork is returned.
The default is false
.DfException
java.lang.String getFile(java.lang.String fileName) throws DfException
Content files associated with objects are ordered within the object.
The position of any particular content file within an object is determined
by its page number. The first content associated with an object has the
page number zero, and the page numbers of subsequent contents increment
by one with each content. When you want to obtain any content file other
than the first, whose page number is zero, you must use the DFC method
getFileEx
.
The following code example demonstrates how to checkout an object and copy the file from the Documentum server to the local drive (current working directory):
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); if (!sysObj.isCheckedOut()) { sysObj.checkout(); sysObj.getFile(sysObj.getObjectName()); }
fileName
- specifies the location where you want to put the
copy of the retrieved content file. If set to null
, the content
will be placed in the DMCL common area.DfException
- if formatName are invalid.getFileEx(java.lang.String, java.lang.String, int, boolean)
,
setFile(java.lang.String)
,
setFileEx(java.lang.String, java.lang.String, int, java.lang.String)
java.lang.String getFileEx(java.lang.String fileName, java.lang.String formatName, int pageNumber, boolean other) throws DfException
fileName
- specifies the location where you want to put the
copy of the retrieved content file. If it is null
, it
will be placed in the DMCL common area.
Note: Files in the client local area or the common area are removed
when the session is closed or when the user terminates the
connection to the Docbase.formatName
- specifies the format in which you want the file.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.other
- for files created on Macintosh systems, indicates
whether you want to retrieve the data fork (the file containing the
content) or the resource fork. If true
, just the resource
fork is returned. If false
, the data fork is returned. The default is false
.DfException
- if formatName
is invalid.java.lang.String getFileEx2(java.lang.String fileName, java.lang.String formatName, int pageNumber, java.lang.String pageModifier, boolean other) throws DfException
fileName
- specifies the location where you want to put the
copy of the retrieved content file. If it is null
, it
will be placed in the DMCL common area.formatName
- specifies the format in which you want the file.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.other
- for files created on Macintosh systems, indicates
whether you want to retrieve the data fork (the file containing the
content) or the resource fork. If true
, the resource
fork is returned. If false
, data fork is returned. The default is false
.DfException
java.lang.String getPath(int pageNumber) throws DfException
pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.setPath(java.lang.String, java.lang.String, int, java.lang.String)
,
mount(java.lang.String)
java.lang.String getPathEx(int pageNumber, java.lang.String pageModifier) throws DfException
pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format.DfException
- if a server error occurs.setPath(java.lang.String, java.lang.String, int, java.lang.String)
,
mount(java.lang.String)
java.lang.String getPathEx2(java.lang.String formatName, int pageNumber, java.lang.String pageModifier, boolean other) throws DfException
formatName
- the format for which you want the path.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format.other
- for files created on Macintosh systems, indicates
whether you want to retrieve the path of the data fork (the file containing the
content) or the path of the resource fork. If true
, the path
of the resource fork is returned. If false
, the path of the
data fork is returned. The default is false
.DfException
- if a server error occurs.setPath(java.lang.String, java.lang.String, int, java.lang.String)
,
mount(java.lang.String)
boolean setContent(java.io.ByteArrayOutputStream content) throws DfException
The following code example demonstrates how to set content residing in memory to a new document:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); byte b[] = {35,36,37,38,39}; ByteArrayOutputStream out = new ByteArrayOutputStream(); out.write(b, 0, 5); sysObj.setContent(out); sysObj.save();
content
- the content as a ByteArrayOutputStream.DfException
- if a server error occurs.appendContent(java.io.ByteArrayOutputStream)
,
insertContent(java.io.ByteArrayOutputStream, int)
boolean setContentEx(java.io.ByteArrayOutputStream content, java.lang.String format, int pageNumber) throws DfException
content
- Specifies the the content.format
- Specifies the file format of the content.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.boolean setContentEx2(java.io.ByteArrayOutputStream content, java.lang.String format, int pageNumber, boolean other) throws DfException
content
- Specifies the the content.format
- Specifies the file format of the content.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.other
- for files created on Macintosh systems, indicates
whether you want to set the data fork (the file containing the
content) or the resource fork. If true
, the resource
fork is set. If false
, the data fork is set. The default
is false
. Note that you can only set this flag to true
right after you set the content for the same page and before the document
is saved.DfException
- if a server error occurs.void setStringContentAttribute(java.lang.String name, java.lang.String value, java.lang.String formatName, int page, java.lang.String pageModifier) throws DfException
name
- the name of the attribute.value
- the value of the attribute.formatName
- the name for the content objects format.page
- the content page.pageModifier
- the content object's page modifier.DfException
void setTimeContentAttribute(java.lang.String name, IDfTime value, java.lang.String formatName, int page, java.lang.String pageModifier) throws DfException
name
- the name of the attribute.value
- the value of the attribute.formatName
- the name for the content objects format.page
- the content page.pageModifier
- the content object's page modifier.DfException
void setDoubleContentAttribute(java.lang.String name, double value, java.lang.String formatName, int page, java.lang.String pageModifier) throws DfException
name
- the name of the attribute.value
- the value of the attribute.formatName
- the name for the content objects format.page
- the content page.pageModifier
- the content object's page modifier.DfException
java.lang.String getStringContentAttr(java.lang.String name, java.lang.String formatName, int page, java.lang.String pageModifier) throws DfException
name
- the name of the attribute.formatName
- the name for the content objects format.page
- the content page.pageModifier
- the content object's page modifier.DfException
IDfTime getTimeContentAttr(java.lang.String name, java.lang.String formatName, int page, java.lang.String pageModifier) throws DfException
name
- the name of the attribute.formatName
- the name for the content objects format.page
- the content page.pageModifier
- the content object's page modifier.DfException
java.lang.Double getDoubleContentAttr(java.lang.String name, java.lang.String formatName, int page, java.lang.String pageModifier) throws DfException
name
- the name of the attribute.formatName
- the name for the content objects format.page
- the content page.pageModifier
- the content object's page modifier.DfException
void setFile(java.lang.String fileName) throws DfException
save
or a
checkin
is performed. Performs a DMCL "setfile".
The following code example demonstrates how to create a document:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); sysObj.setFile("c:\\textdoc.txt"); sysObj.save();
fileName
- the file that contains the content.DfException
- if a server error occurs.insertFile(java.lang.String, int)
,
appendFile(java.lang.String)
void setFileEx(java.lang.String fileName, java.lang.String formatName, int pageNumber, java.lang.String otherFile) throws DfException
save
or a
checkin
is performed.
Performs DMCL "setfile".fileName
- specifies the file that contains the content.formatName
- specifies the format in which you want the file.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.otherFile
- specifies the resource fork for a Macintosh document.
This argument should be set to null
for non-Macintosh documents.DfException
- if a server error occurs.void setPath(java.lang.String fileName, java.lang.String formatName, int pageNumber, java.lang.String otherFile) throws DfException
fileName
- Specifies the file that contains the content.
Use either an absolute or relative path to specify the file.
The file must be located on the machine from which this
method is called or in a directory visible to that machine.formatName
- Specifies the content's file format. The format must be a
valid file format. You must specify this argument if you are
setting an object's first content. Set this argument to null
when you are setting second or subsequent content for an
object.pageNumber
- Defines the position where you want to place the content
within the ordered contents of the object. Use this argument
when you are adding second or subsequent contents to an
object or when you want to replace an existing content.
Otherwise, set this to 0.otherFile
- specifies the resource fork for a Macintosh document.
You can use either an absolute or a relative path.
If this is set, the path must be valid or this method
fails. The value is ignored when used with external
stores.
This argument should be set to null
for non-Macintosh documents.DfException
- if a server error occurs.getPath(int)
,
mount(java.lang.String)
void appendContent(java.io.ByteArrayOutputStream content) throws DfException
The following code example demonstrates how to append content to a new document:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); byte b[] = {35,36,37,38,39}; ByteArrayOutputStream out = new ByteArrayOutputStream(); out.write(b, 0, 5); sysObj.appendContent(out); sysObj.save();
content
- the content as a ByteArrayOutputStream object.DfException
- if a server error occurs.setContent(java.io.ByteArrayOutputStream)
,
insertContent(java.io.ByteArrayOutputStream, int)
void appendContentEx(java.io.ByteArrayOutputStream content, boolean other) throws DfException
The following code example demonstrates how to append content to a new document:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); byte b[] = {35,36,37,38,39}; ByteArrayOutputStream out = new ByteArrayOutputStream(); out.write(b, 0, 5); sysObj.appendContent(out); sysObj.save();
content
- the content as a ByteArrayOutputStream object.other
- for files created on Macintosh systems, indicates
whether you want to set a data fork (the file containing the
content) or a resource fork. If true
, the resource
fork is set. If false
, the data fork is set. The
default is false
.DfException
- if a server error occurs.setContent(java.io.ByteArrayOutputStream)
,
insertContent(java.io.ByteArrayOutputStream, int)
void appendFile(java.lang.String fileName) throws DfException
When you add content to a document, you can append the new file to the end of the document's list of content files or you can insert the file into the list. This method appends the content to the end of the document's list of content files.
The following code example demonstrates how to append content to a new document:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); sysObj.appendFile("c:\\tesdoc1.txt"); sysObj.appendFile("c:\\tesdoc2.txt"); sysObj.save();
fileName
- the file that you are adding as
content to the object. Use either a relative
or absolute path specification.DfException
- if a server error occurs.void appendFileEx(java.lang.String fileName, java.lang.String otherFileName) throws DfException
When you add content to a document, you can append the new file to the end of the document's list of content files or you can insert the file into the list. This method appends the content to the end of the document's list of content files.
The following code example demonstrates how to append content to a new document:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testDoc"); sysObj.setContentType("crtext"); sysObj.appendFile("c:\\tesdoc1.txt"); sysObj.appendFile("c:\\tesdoc2.txt"); sysObj.save();
fileName
- the file that you are adding as
content to the object. Use either a relative
or absolute path specification.otherFileName
- specifies the resource fork for an
object with Macintosh content.DfException
- if a server error occurs.void insertContent(java.io.ByteArrayOutputStream content, int pageNumber) throws DfException
content
- specifies the contentpageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.void insertContentEx(java.io.ByteArrayOutputStream content, int pageNumber, boolean other) throws DfException
content
- specifies the contentpageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.other
- for files created on Macintosh systems, indicates
whether you want to set a data fork (the file containing the
content) or a resource fork. If true
, the resource
fork is set. If false
, the data fork is set. The
default is false
.DfException
- if a server error occurs.void insertFile(java.lang.String fileName, int pageNumber) throws DfException
fileName
- Specifies the file that you are adding to the object.
Use either an absolute or relative path to specify the file.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.void insertFileEx(java.lang.String fileName, int pageNumber, java.lang.String otherFileName) throws DfException
fileName
- Specifies the file that you are adding to the object.
Use either an absolute or relative path to specify the file.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.otherFileName
- specifies the resource fork for an
object with Macintosh content.DfException
- if a server error occurs.void addRendition(java.lang.String fileName, java.lang.String formatName) throws DfException
save
or checkin
is performed.
The following code example demonstrates how to add a Word Perfect rendition to the sysobject:
IDfSysObject sysObj = (IDfSysObject)session.getObjectByQualification("dm_document where r_object_id='0900d5bb8001f900'"); sysObj.addRendition("chap_1.wp7", "wp7"); sysObj.save();
fileName
- specifies the file that contains the content.formatName
- specifies the content's file format.DfException
- if a server error occurs.void addRenditionEx(java.lang.String fileName, java.lang.String formatName, int pageNumber, java.lang.String storageName, boolean atomic) throws DfException
save
or a
checkin
is performed.
Perform DMCL "addrendition".fileName
- specifies the file that contains the content.formatName
- specifies the content's file format.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.storageName
- identifies the storage area where you want to
store the new rendition..atomic
- indicates whether you want the changes resulting
from the addRendition operation to be saved
automatically to the repository. Set this to true
to save the changes automatically or false
if you
want to require an explicit save operation.DfException
- if a server error occurs.void 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) throws DfException
save
or a
checkin
is performed.
Perform DMCL "addrendition".fileName
- specifies the file that contains the content.formatName
- specifies the content's file format.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document. If there already exists a
rendition with the supplied page_modifier (at the given
format and page) the rendition will be overwritten.
If null
is passed then page_modifier is set
to empty string.
This argument must be null
if the batch
argument
is true
.
The argument cannot be "dm_batch" as this is a reserved word.storageName
- identifies the storage area where you want to
store the new rendition..atomic
- indicates whether you want the changes resulting
from the addRendition operation to be saved
automatically to the repository. Set this to true
to save the changes automatically or false
if you
want to require an explicit save operation.keep
- indicates whether this rendition should remain
(i.e. not be removed) when the primary content with the
same page number is removed or updated.batch
- indicates whether the fileName
argument is a
tar-ed file containing a set of content files including a
a property file named 'property.txt'.
The format of of this property file is as follows
(with a blank line separating each file_name entry):
file_name='file_name'
page_modifier='DfException
void 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) throws DfException
save
or a
checkin
is performed.
Perform DMCL "addrendition".fileName
- specifies the file that contains the content.formatName
- specifies the content's file format.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document. If there already exists a
rendition with the supplied page_modifier (at the given
format and page) the rendition will be overwritten.
If null
is passed then page_modifier is set
to empty string.
This argument must be null
if the batch
argument
is true
.
The argument cannot be "dm_batch" as this is a reserved word.storageName
- identifies the storage area where you want to
store the new rendition..atomic
- indicates whether you want the changes resulting
from the addRendition operation to be saved
automatically to the repository. Set this to true
to save the changes automatically or false
if you
want to require an explicit save operation.keep
- indicates whether this rendition should remain
(i.e. not be removed) when the primary content with the
same page number is removed or updated.batch
- indicates whether the fileName
argument is a
tar-ed file containing a set of content files including a
a property file named 'property.txt'.
The format of of this property file is as follows
(with a blank line separating each file_name entry):
file_name='file_name'
page_modifier='otherFileName
- specifies the resource fork for an
object with Macintosh content.DfException
IDfCollection getRenditions(java.lang.String attrNames) throws DfException
attrNames
in the form of a comma
separated list suitable for inclusion in a DQL select list are returned. If attrNames
is null or a zero length String, values for the following default attributes
are returned - full_format, content_size, set_time, set_file. Rsults are sorted
by the first element in the attrNames
.DfException
- if a server error occurs.void removeContent(int pageNumber) throws DfException
pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.DfException
- if a server error occurs.void removeRendition(java.lang.String formatName) throws DfException
save
or a
checkin
is performed.
Perform DMCL "removerendition".formatName
- Defines the format of the file you are removing.DfException
- if a server error occurs.void removeRenditionEx(java.lang.String formatName, int pageNumber, boolean atomic) throws DfException
save
or a
checkin
is performed.
Perform DMCL "removerendition".formatName
- Defines the format of the file you are removing.pageNumber
- Identifies the position of the content when the object has
multiple contents; otherwise, use 0.atomic
- Indicates whether you want the changes that result from
the removeRendition operation to be saved automatically
to the repository. Set this to true
to save the changes
automatically or to false
to require an explicit save
operation.DfException
- if a server error occurs.void removeRenditionEx2(java.lang.String formatName, int pageNumber, java.lang.String pageModifier, boolean atomic) throws DfException
save
or a
checkin
is performed.
Perform DMCL "removerendition".formatName
- Defines the format of the file you are removing.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format for a document.
If null
value is passed then all renditions are
removed at the specified page number and format.
If you want to remove the rendition with an empty
page_modifier value, pass in an empty string value
(i.e. '').atomic
- Indicates whether you want the changes that result from
the removeRendition operation to be saved automatically
to the repository. Set this to true
to save the changes
automatically or to false
to require an explicit save
operation.DfException
- if a server error occurs.void bindFile(int pageNumber, IDfId srcId, int srcPageNumber) throws DfException
pageNumber
- Specifies the position of the new content in the ordered
contents of the target object. Specify 0 if this is the
first content for the object.srcId
- Identifies the object in which the content currently
resides.srcPageNumber
- Identifies which content you want to retrieve.
Use the contents page number.DfException
- if a server error occurs.@Deprecated void mount(java.lang.String path) throws DfException
getfile
or a
getcontent
method, then the content will be retrieved on the server side if a server side plugin is
available and returned to the client application.path
- Specifies the path of the external file store.DfException
- if a server error occurs.getPath(int)
,
setPath(java.lang.String, java.lang.String, int, java.lang.String)
void addNote(IDfId targetId, boolean keepPermanent) throws DfException
targetId
- Specifies the id of the sysobject to which the annotation is being added.keepPermanent
- Indicates whether you want the annotation to remain
attached to the document when users version the
document.DfException
- if a server error occurs.@Deprecated void removeNote(IDfId annotationId) throws DfException
annotationId
- Specifies the id of the sysobject from which the annotation is being removed.DfException
- if a server error occurs.IDfId getPolicyId() throws DfException
DfException
- if a server error occurs.java.lang.String getPolicyName() throws DfException
DfException
- if a server error occurs.int getResumeState() throws DfException
DfException
- if a server error occurs.java.lang.String getResumeStateName() throws DfException
DfException
- if a server error occurs.int getCurrentState() throws DfException
DfException
- if a server error occurs.java.lang.String getCurrentStateName() throws DfException
DfException
- if a server error occurs.void attachPolicy(IDfId policyId, java.lang.String state, java.lang.String scope) throws DfException
Business policies define object life cycles. Each business policy defines a series of states (such as review or approved) through which an object progresses. A policy includes requirements that must be met before the object can move from one state to the next, actions to be performed before the object enters a state, and postprocessing to perform after entering a new state.
The following code example demonstrates how to attach a business policy object to a sysobject where the initial state of the lifecycle is defined as "preliminary":
IDfSysObject busPolicyObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001f900")); sysObj.attachPolicy(busPolicyObj.getObjectId(), "preliminary", "");
You cannot use this method in a user-defined transaction.
policyId
- the object id of the business policy object.state
- the state of the business policy. The state
can be the position of the state or the state name.scope
- is the key to the dm_alias_set type for retrieving
the alias value mapping defined there.DfException
- if a server error occurs.detachPolicy()
void detachPolicy() throws DfException
The following code example demonstrates how to detach a business policy object from a sysobject;
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001f900")); sysObj.detachPolicy();
DfException
- if a server error occurs.attachPolicy(com.documentum.fc.common.IDfId, java.lang.String, java.lang.String)
void promote(java.lang.String state, boolean override, boolean fTestOnly) throws DfException
state
argument. The state can be passed in as the position or the name of the state.You cannot use this method in a user-defined transaction.
state
- is the state to which sysobject is to be promoted. If null
,
the object will be promoted to the next normal state.override
- optionally, set this to true
to force the sysobject to be
promoted, regardless of other conditions.fTestOnly
- set this to true
to test if the promote can be done. This
will not actually promote the object.DfException
- if a server error occurs.java.lang.String getPreviousStateName() throws DfException
DfException
- if a server error occurs.java.lang.String getNextStateName() throws DfException
DfException
- if a server error occurs.boolean canPromote() throws DfException
1. The correct Business Policy is installed and attached. 2. The objects current state is NOT a terminal state and is NOT an exception state.
true
if the object can be promoted, false
otherwise.DfException
- if a server error occurs.void schedulePromote(java.lang.String state, IDfTime scheduleDate, boolean override) throws DfException
scheduleDate
parameter. This scheduled promotion can be enforced by setting the
override
parameter to true
.state
- is the state to which sysobject is to be promoted. This is
required for schedule promote.scheduleDate
- is the time and date sysobject will be promoted.override
- set this to true
to force the sysobject's promotion.DfException
- if a server error occurs.void cancelScheduledPromote(IDfTime scheduleDate) throws DfException
scheduleDate
argument.scheduleDate
- the date/time used to set the schedule promote.DfException
- if a server error occurs.boolean canDemote() throws DfException
1. Correct BP is installed and attached.
2. Objects current state is NOT a base state and is NOT
an exception state.
3. "allow_demote" attribute is set to true
for the current state.
true
if the object can be demoted, false
otherwise.DfException
- if a server error occurs.void demote(java.lang.String state, boolean toBase) throws DfException
toBase
parameter is set to true
. If state
is not null
,
the current state should be the state right after the state specified.You cannot use this method in a user-defined transaction.
state
- the state to which the sysobject will be demoted. This can be
the name of the state or position number.toBase
- set this to true
if sysobject is to be demoted to the base state.
If the state is specified with this flag as true
, the state
should be the base state.DfException
- if a server error occurs.void scheduleDemote(java.lang.String state, IDfTime schedule_date) throws DfException
state
parameter. The state
parameter cannot be null
in this case.state
- is the state to which the sysobject will be demoted. This can
be the name of the state or the position number.schedule_date
- represent the date/time used to set the schedule demote
for this sysobject.DfException
- if a server error occurs.void cancelScheduledDemote(IDfTime scheduleDate) throws DfException
scheduleDate
.scheduleDate
- the date/time used to set the demote
for this sysobject.DfException
- if a server error occurs.void suspend(java.lang.String state, boolean override, boolean fTestOnly) throws DfException
You cannot use this method in a user-defined transaction.
state
- if specified, this should be the current state from where the
sysobject will be suspended. This can be either the position
number or the name of the state.override
- setting this to true
will force the sysobject to suspend.fTestOnly
- set this to true
to test if the suspend can be done. This
will not actually suspend the object.DfException
- if a server error occurs.boolean canSuspend() throws DfException
1. The correct Business Policy is installed and attached. 2. The objects current state has an exception state.
true
if the object can be suspended, false
otherwise.DfException
- if a server error occurs.boolean isSuspended() throws DfException
1. The correct Business Policy is installed and attached. 2. The objects current state is an exception state.
true
if the object is in the suspended state, false
otherwise.DfException
- if a server error occurs.void scheduleSuspend(java.lang.String state, IDfTime scheduleDate, boolean override) throws DfException
state
- this should be the current state from where the
sysobject will be suspended. This can be either the position
number or the name of the state. This can not be null
.override
- set this to true
to force the sysobject's suspension.scheduleDate
- the date/time used to set the schedule suspend
for this sysobject.DfException
- if a server error occurs.void cancelScheduledSuspend(IDfTime scheduleDate) throws DfException
scheduleDate
- the date/time at which the sysobject was
scheduled for suspension.DfException
- if a server error occurs.void resume(java.lang.String state, boolean toBase, boolean override, boolean fTestOnly) throws DfException
You cannot use this method in a user-defined transaction.
state
- define the state number or the state name from where the sysobject
will be resumed. This must be an exception state.toBase
- set it to true
if sysobject is to be resumed to the base state.override
- set this to true
to force the resume.fTestOnly
- set this to true
to test if the resume can be done. This
will not actually resume the object.DfException
- if a server error occurs.boolean canResume() throws DfException
1. The correct Business Policy is installed and attached. 2. The objects current state is an exception state.
true
if the object can be resumed, false
otherwise.DfException
- if a server error occurs.void scheduleResume(java.lang.String state, IDfTime scheduleDate, boolean toBase, boolean override) throws DfException
state
- define the state number or the state name from where the sysobject
will be resumed from. This must be an exception state.scheduleDate
- contains the date/time at which the resume will take place.toBase
- set this to true
if the sysobject is to be resumed to the base state.override
- set this to true
to force the resume.DfException
- if a server error occurs.void cancelScheduledResume(IDfTime schedule) throws DfException
schedule
- represent the date/time which was used to schedule the resume.DfException
- if a server error occurs.boolean isVirtualDocument() throws DfException
true
if this is a virtual document.DfException
- if a server error occurs.void setIsVirtualDocument(boolean is_virtual_doc) throws DfException
isVirtualDocument
to return false
;
isVirtualDocument
will return true
for as long as there are containment
children.is_virtual_doc
- If true
, the document will be treated as a virtual
document even if it has no children. If false
, the document
will not be treated as a virtual document ONLY if it has no
children.DfException
- if a server error occurs.IDfId getAssembledFromId() throws DfException
DfException
- if a server error occurs.int getFrozenAssemblyCount() throws DfException
DfException
- if a server error occurs.boolean getHasFrozenAssembly() throws DfException
DfException
- if a server error occurs.java.lang.String getCompoundArchitecture() throws DfException
DfException
- if a server error occurs.void setCompoundArchitecture(java.lang.String compoundArchitecture) throws DfException
The a_compound_architecture attribute is used internally by the Documentum clients' Virtual Document Manager (VDM) to determine if the object can be structurally changed in the VDM. If an object's a_compound_architecture attribute is set to any value other than an empty string, VDM assumes the object is read only and does not allow any structural changes in the object.
compoundArchitecture
- specifies if the object can be structurally changed by the virtual document managerDfException
- if a server error occurs.java.lang.String getResolutionLabel() throws DfException
DfException
- if a server error occurs.void setResolutionLabel(java.lang.String label) throws DfException
label
- specifies the resolution label for the object.DfException
- if a server error occurs.int getLinkCount() throws DfException
DfException
- if a server error occurs.int getLinkHighCount() throws DfException
DfException
- if a server error occurs.boolean isLinkResolved() throws DfException
DfException
- if a server error occurs.void setLinkResolved(boolean linkResolved) throws DfException
linkResolved
- specifies the object has been archived.DfException
- if a server error occurs.IDfId appendPart(IDfId componentId, java.lang.String versionLabel, boolean useNodeVerLabel, boolean followAssembly, int copyChild) throws DfException
componentId
- the object id or chronicle id of the document to be appended.versionLabel
- the version label to use to bind to the new child document.useNodeVerLabel
- if true
, causes any late bound descendents of the child
to inherit the early binding of the child.followAssembly
- if true
and an assembly is present for the child document,
will cause virtual document operations to use the assembly in place of any
virtual or compound descendents.copyChild
- determines if a new copy of the child should be created when this
parent is copied. A value of 0 indicates that the user (caller) will decide.
A value of 1 will reference the same child in the newly copied parent. A
value of 2 will cause a new copy of the child to be assocaited with the
newly copied parent.DfException
- if a server error occurs.IDfId insertPart(IDfId componentID, java.lang.String versionLabel, IDfId beforeContainmentId, double orderNo, boolean orderNoFlag, boolean useNodeVerLabel, boolean followAssembly, int copyChild) throws DfException
componentID
- the object id or chronicle id of the document to be inserted.versionLabel
- the version label to use to bind to the new child document.beforeContainmentId
- specifies the containment id occupying the position
at which the new component should be inserted.orderNo
- can be used in place of beforeContainmentId to specify the
point at which the new child should be inserted.orderNoFlag
- if true
, orderNo will specify the insertion point.
If false
, beforeContainmentId
will specify the insertion point.useNodeVerLabel
- if true
, causes any late bound descendents of the child
to inherit the early binding of the child.followAssembly
- if true
and an assembly is present for the child document,
will cause virtual document operations to use the assembly in place of any
virtual or compound descendents.copyChild
- determines if a new copy of the child should be created when this
parent is copied. A value of 0 indicates that the user (caller) will decide.
A value of 1 will reference the same child in the newly copied parent. A
value of 2 will cause a new copy of the child to be assocaited with the
newly copied parent.DfException
- if a server error occurs.void removePart(IDfId containmentId, double orderNo, boolean orderNoFlag) throws DfException
containmentId
- the object id for the dmr_containment representing the
child to be removed.orderNo
- can be used in place of containmentId to specify the
part to be removed.orderNoFlag
- if true
, orderNo
will specify
the part to be removed. If false
containmentId
will specify the part to be removed.DfException
- if a server error occurs.void updatePart(IDfId containmentId, java.lang.String versionLabel, double orderNumber, boolean useNodeVerLabel, boolean followAssembly, int copyChild) throws DfException
containmentId
- the object id of the dmr_containment to be updated.versionLabel
- the version label to use to bind to the child document.orderNumber
- sequence number of this child relative to its siblings.useNodeVerLabel
- if true
, causes any late bound descendants of the child
to inherit the early binding of the child.followAssembly
- if true
and an assembly is present for the child document,
will cause virtual document operations to use the assembly in place of any
virtual or compound descendents.copyChild
- determines if a new copy of the child should be created when this
parent is copied. A value of 0 indicates that the user (caller) will decide.
A value of 1 will reference the same child in the newly copied parent. A
value of 2 will cause a new copy of the child to be associated with the
newly copied parent.DfException
- if a server error occurs.void updatePartEx(IDfId containmentId, java.lang.String versionLabel, double orderNumber, boolean useNodeVerLabel, boolean followAssembly, int copyChild, java.lang.String containType, java.lang.String containDesc) throws DfException
DfException
IDfCollection assemble(IDfId virtualDocId, int interruptFreq, java.lang.String qualification, java.lang.String nodesortList) throws DfException
virtualDocId
- the object id of the virtual doucment to traverse in
the creation of the assembly.interruptFreq
- specifies how often the system stops the assembly
process and turns control back to the caller (via the collection).qualification
- determines which nodes will be selected for inclusion in
the assembly. A qualification is the portion of a DQL SELECT statement
that follows "FROM". Pass an empty string to include all nodes.nodesortList
- comma separated list of attributes on which you want to
sort version that are candidates for inclusion in the assembly.DfException
- if a server error occurs.void disassemble() throws DfException
DfException
- if a server error occurs.boolean isFrozen() throws DfException
DfException
- if a server error occurs.void freeze(boolean freezeComponents) throws DfException
freezeComponents
- Indicates whether you want to freeze
the components that make up the specified
object's assembly as well as the object
itself. Set this flag to true
to freeze the
assembled components as well as the object.
This flag is only set if the specified object
is a virtual document that has an associated
assembly.DfException
- if a server error occurs.void unfreeze(boolean thawComponents) throws DfException
thawComponents
- Indicates whether you want to unfreeze
the assembly associated with the specified
object. Set this to true
to unfreeze the assembly.DfException
- if a server error occurs.IDfVirtualDocument asVirtualDocument(java.lang.String lateBindingValue, boolean followRootAssembly) throws DfException
Refer to Server Fundamentals for more information about virtual documents.
The following code example demonstrates how to obtain a virtual document representation of an sysobject:
IDfSysObject sysObjRoot = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); IDfVirtualDocument vDoc = sysObjRoot.asVirtualDocument("CURRENT", false);
lateBindingValue
- the symbolic version label to use to resolve late bound nodes.followRootAssembly
- if true
, the assembly specified by the root node will be used
as the "virtual" document.DfException
- if a server error occurs.int getComponentIdCount() throws DfException
DfException
- if a server error occurs.IDfId getComponentId(int index) throws DfException
index
- specifies the position of the component in the virtual document.DfException
- if a server error occurs.int getContainIdCount() throws DfException
DfException
- if a server error occurs.IDfId getContainId(int index) throws DfException
index
- specifies the position of the containment object.DfException
- if a server error occurs.boolean isReference() throws DfException
DfException
- if a server error occurs.java.lang.String getMasterDocbase() throws DfException
DfException
- if a server error occurs.IDfId addReference(IDfId folderId, java.lang.String bindingCondition, java.lang.String bindingLabel) throws DfException
folderId
- specifies the folder the reference object is added.bindingCondition
- the binding condition for the reference object.
It can be one of the following 2 values:
EXACT_ID - the bindingLabel is ignored.
VERSION_LABEL - the bindingLabel
parameter will specify
the version label of the object to bind to.
bindingLabel
- the binding label for the reference object.DfException
- if a reference cannot be added or
if a server error occurs.void refreshReference() throws DfException
DfException
- if this object is not a reference object or
if a server error occurs.IDfId getRemoteId() throws DfException
DfException
- if this object is not a reference object or
if a server error occurs.IDfId getAliasSetId() throws DfException
DfException
- if a server error occurs.java.lang.String getAliasSet() throws DfException
DfException
- if a server error occurs.java.lang.String resolveAlias(java.lang.String scopeAlias) throws DfException
scopeAlias
- the name of the alias you want to search for in the following format:
%[scope].alias
, where scope
is the name of the alias
set associated with the sysobject.DfException
- if a server error occurs.java.lang.String print(java.lang.String printer, boolean printCover, boolean saveOutput, int numCopies, int startingContentPage, int endingContentPage) throws DfException
printer
- Specifies the printer that you want to use. Use the object
name of the output device object that represents the printer.
If you do not specify a printer, the default is the system
printer.printCover
- Directs the printer to print a cover page.saveOutput
- Directs the system to save the postscript output generated
by the printing process.numCopies
- Defines the number of copies that you want to print.startingContentPage
- Defines the content file with which to start printing.endingContentPage
- Defines the content file at which to end printing.DfException
- if a server error occurs.IDfId queue(java.lang.String queueOwner, java.lang.String event, int priority, boolean sendMail, IDfTime dueDate, java.lang.String message) throws DfException
The following code example demonstrates how to queue an item into a user's inbox:
IDfSysObject sysObj = (IDfSysObject)sess.getObject(new DfId("0900d5bb8001fd49")); IDfTime t = new DfTime("08/09/2000", "mm/dd/yyyy"); IDfId inboxId = sysObj.queue("tuser","EventName",1,false,time,"Please review.");
queueOwner
- identifies the queue where you
want to place the object.
Specify the Documentum username of the
queue's owner.event
- provides information to be interpreted by
the application about the specified object.priority
- defines an application- or user-interpreted
priority level for the queued item.sendMail
- directs the server to send an electronic
message to the queue's owner notifying the
owner that an item has been placed on his or
her queue. The notification includes the
text of the message argument.dueDate
- a date for the completion of the
work represented by the queued object.message
- defines a message to the owner of the queue
on which you are placing the task.DfException
- if a server error occurs.boolean getHasEvents() throws DfException
true
if users have registered to receive events for the object.DfException
- if a server error occurs.IDfCollection getRouters(java.lang.String additionalAttributes, java.lang.String orderBy) throws DfException
additionalAttributes
- for the query string. The parameter is in
the form of a comma delimited string
orderBy contains the attribute name to be used for the order by clauseDfException
- if the query failed.IDfCollection getWorkflows(java.lang.String additionalAttributes, java.lang.String orderBy) throws DfException
additionalAttributes
- for the query string, and is in the
form of a comma delimited string
orderBy contains the attribute name to be used for the order by clauseDfException
- if the query failed.IDfCollection getVdmPath(IDfId rootId, boolean shortestPath, java.lang.String versionList) throws DfException
rootId
- object ID of a virtual document that contains the component.
If you include this argument, the method returns only paths
that start with the specified virtual document.
If null
, the method returns all paths to component.shortestPath
- if TRUE
thie method returns only the shortest path
to the component. This argument is FALSE
by default.versionList
- Defines one or more version labels to be used to select a
version when a late-bound component is encountered in a
path. You can specify implicit or symbolic version labels.
If you include multiple version labels, separate them with
commas in a single string variable.IDfCollection
The Vdmpath method returns a collection in which each row contains a result
object that represents one path to the component. The result objects have four repeating attributes:
r_object_id, i_chronicle_id, object_name, and title. The values at corresponding index positions across
the attributes represent one node in the path to the component.
* @exception DfException if a server error occurs.
The following code example demonstrates the usage of this method.
IDfCollection collection = null; try { collection = childSysObj.getVdmPath(null, false, "approved,released"); String attributeName = "object_name"; while (collection.next()) { IDfTypedObject obj = collection.getTypedObject(); int count = obj.getValueCount(attributeName); StringBuffer vdmPath = new StringBuffer(64 * count); vdmPath.append(obj.getRepeatingString(attributeName, 0)); for (int i = 0; i < count; i++) { vdmPath.append(obj.getRepeatingString(attributeName, i)); vdmPath.append("--->"); } System.out.println(vdmPath.toString()) ; } } catch(DfException dfc); { // Error handling code } finally { if (collection != null) collection.close(); }
DfException
IDfCollection getVdmPathDQL(IDfId rootId, boolean shortestPath, java.lang.String parentType, java.lang.String bindingLabel, java.lang.String nodeSortBy) throws DfException
rootId
- object ID of a virtual document that contains the component.
If you include this argument, the method returns only paths
that start with the speci?ed virtual document.
If null
, the method returns all paths to component.shortestPath
- if TRUE
thie method returns only the shortest path
to the component. This argument is FALSE
by default.parentType
- object type of the parent documents in the paths
to the component.if null, the default value set is "dm_sysobject".bindingLabel
- defines a quali?cation used to select a version when a
late-bound component is encountered in the path search. The
quali?cation is that part of a DQL SELECT statement that
appears after the WHERE clause.nodeSortBy
- defines a selection criteria for returned versions if more than
one version of a late-bound component meets the conditions
imposed in binding_condition. Applies only if binding_condition is included.IDfCollection
The Vdmpath method returns a collection in which each row contains a result
object that represents one path to the component. The result objects have four repeating attributes:
r_object_id, i_chronicle_id, object_name, and title. The values at corresponding index positions across
the attributes represent one node in the path to the component.DfException
- if a server error occurs.java.lang.String getExceptionStateName() throws DfException
DfException
- if a server error occurs.IDfId addDigitalSignature(java.lang.String userName, java.lang.String reason) throws DfException
userName
- The name of the user who actually signed this DfSysObject or null
to indicate the connected user signed.reason
- Up to 200 characters describing why the document was signed or null.DfException
IDfId 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) throws DfException
userName
- The name of the user who is signing.
If empty then the name of the currently
logged in user is used.password
- The password used to authenticate the user.signatureJustification
- The reason given for signing the document.
This text is included on the signature page.formatToSign
- The content type which will receive the
signature page. If empty then 'pdf' is used.
A custom signature method must be provided
in order to sign formats other than 'pdf'.hashAlgorithm
- Specifies the hash algorithm to use when
hashing the content. Currently only "SHA-1"
is supported. If empty then "SHA-1" is used.preSignatureHash
- A string containing a hash of the document
that is being signed. This is used by the
server to confirm identity of the document
prior to signing. If empty then no
check is made. The hash result is represented
in hex and formatted along with the hash algorithm
and the content format. Currently only "SHA-1"
and "pdf" are supported. The string has the
form:
{SHA-1}/{pdf}:f64d3298b660119d5adbbf03f4eb683bca98b5a1signatureMethodName
- The name of the server method that will add
the signature page. If empty then the default
method "esign_pdf" will be used. Custom signature
methods can be created and specified here.applicationProperties
- Used to optionally pass additional signature
information to the signature method for
inclusion on the signature page.
See the server addesignature method documentation
for signature page customization details.
hashing the content. Currently only "SHA-1"
is supported. If empty then "SHA-1" is used.passThroughArgument1
- This argument can be used to pass information
to custom signature methods. It is unused by
the default signature method.passThroughArgument2
- This argument can be used to pass information
to custom signature methods. It is unused by
the default signature method.DfException
- if a server error occurs.void verifyESignature() throws DfException
DfException
- if the signature cannot be verified.IDfContentAvailability getContentAvailability(java.lang.String formatName, int pageNumber, java.lang.String pageModifier, java.lang.String networkLocationIdentifier) throws DfException
formatName
- specifies the format in which you want the file.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.networkLocationIdentifier
- user network location identifierDfException
- if a server error occurs.boolean isContentTransferCapabilityEnabled(java.lang.String networkLocationIdentifier, IDfContentTransferCapability capability) throws DfException
networkLocationIdentifier
- user network location identifiercapability
- content transfer capabilityDfException
- if a server error occurs.IDfEnumeration getAcsRequests(java.lang.String formatName, int pageNumber, java.lang.String pageModifier, IDfAcsTransferPreferences transferPreferences) throws DfException
IDfEnumeration
object containing a list of IDfAcsRequest
objects.
These objects allow accessing content, using ACS and/or BOCS.formatName
- specifies the format in which you want the file.pageNumber
- identifies the position of the content when the object has
multiple contents; otherwise, use 0.pageModifier
- uniquely identifies a rendition within the same page number
and format.
If null
is passed then the rendition with an
empty page_modifier value is returned.
But if there doesn't exist a rendition without a page_modifier
and null
is passed, then the one with the
smallest page_modifier (in alphabetical order) will be
returned.transferPreferences
- IDfAcsTransferPreferences
object to be used.IDfEnumeration
of IDfAcsRequest
objects for
the requested content.DfException
- if a server error occurs.IDfTime getRetainUntilDate() throws DfException
DfException
int getRetainerCount() throws DfException
DfException
IDfId getRetainerId(int index) throws DfException
index
- DfException
long getContentSize(int page, java.lang.String formatName, java.lang.String pageModifier) throws DfException
page
- page number of the contentformatName
- format of the contentpageModifier
- pageModifier of the contentDfException
long getOtherFileSize(int page, java.lang.String formatName, java.lang.String pageModifier) throws DfException
page
- page number of the contentformatName
- format of the contentpageModifier
- pageModifier of the contentDfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.