public interface IDfCheckedOutObject extends IDfClientRegistryObject
Modifier and Type | Method and Description |
---|---|
void |
addSharedDocument(IDfId parentId)
Adds the object id of the parent that shares this checked out object.
|
void |
clearModifiedAttrs()
Removes all the modified attributes.
|
boolean |
getCreatedAsLocalCopy()
Returns whether or not the checked out object was originally created as
a Desktop Client local file.
|
boolean |
getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
java.lang.String |
getMasterObjectId()
Returns the master object id of the current checked out object.
|
java.lang.String |
getModified() |
java.lang.String |
getModifiedAttr(java.lang.String name)
Gets the value of a modified attribute.
|
IDfList |
getModifiedAttrs()
Returns a list of attribute names for the attributes that have been
modified while the document is checked out.
|
IDfList |
getSharedDocuments()
Returns the list of the object id's of all the documents that share this checked out object
|
java.lang.String |
getUserName()
Returns the user name for the user who checked out this document.
|
java.lang.String |
getVersion()
Returns the implict version label of the checked out document.
|
void |
removeSharedDocument(IDfId parentId)
Removes the object id of the document that shares this checked out object.
|
void |
setCreatedAsLocalCopy(boolean createdAsLocalCopy)
Set whether the checked-out object was originally created as a local file
|
void |
setKeepLocalFile(boolean keepLocalFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted when the document is checked back in to the docbase.
|
void |
setMasterObjectId(java.lang.String masterObjectId)
Sets the master object id of the replica or reference object.
|
void |
setModified(java.lang.String modified)
Sets the modification date of the file
|
void |
setModifiedAttr(java.lang.String name,
java.lang.String value)
Marks that an attribute has been changed with the checked-out object.
|
void |
setUserName(java.lang.String userName)
Sets the full user name of the user
|
void |
setVersion(java.lang.String version)
Sets the version label of the object
|
getContentIdentifier, getDocbaseId, getDocbaseName, getDocbroker, getDomainName, getFilePath, getFolderPath, getFormat, getFormatDescription, getObjectId, getObjectName, getResourceForkIdentifier, getTitle, getType, getUser, getVStamp, isDirty, loadFromRegistry, setContentIdentifier, setDocbaseId, setDocbaseName, setDocbroker, setDomainName, setFilePath, setFolderPath, setFormat, setFormatDescription, setObjectId, setObjectName, setResourceForkIdentifier, setTitle, setType, setUser, setVStamp, updateRegistry
void setKeepLocalFile(boolean keepLocalFile)
keepLocalFile
- if true the local content file will not be deleted.boolean getKeepLocalFile()
void setCreatedAsLocalCopy(boolean createdAsLocalCopy)
createdAsLocalCopy
- true if the file was originally a local fileboolean getCreatedAsLocalCopy()
void setUserName(java.lang.String userName)
userName
- the full user name of the userjava.lang.String getUserName()
void setModified(java.lang.String modified)
modified
- the modification date of the filejava.lang.String getModified()
void setVersion(java.lang.String version)
version
- the version label of the objectjava.lang.String getVersion()
IDfList getModifiedAttrs() throws DfException
DfException
void setModifiedAttr(java.lang.String name, java.lang.String value) throws DfException
name
- the name of the attributevalue
- the value the attribute have been changed toDfException
java.lang.String getModifiedAttr(java.lang.String name) throws DfException
name
- the name of a modified attributeDfException
void clearModifiedAttrs()
IDfList getSharedDocuments() throws DfException
DfException
void addSharedDocument(IDfId parentId) throws DfException
parentId
- the id of the parent object that shares this checked out object.DfException
void removeSharedDocument(IDfId parentId) throws DfException
parentId
- object id of the document that shares this checked out objectDfException
void setMasterObjectId(java.lang.String masterObjectId) throws DfException
masterObjectId
- master object id of the current checked out object.DfException
java.lang.String getMasterObjectId() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.