public interface IDfClientRegistryObject
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getContentIdentifier()
Returns content identifier
|
java.lang.String |
getDocbaseId()
Returns the repository identifier for the repository to which the object belongs.
|
java.lang.String |
getDocbaseName()
Returns the name of the repository this object belongs to.
|
java.lang.String |
getDocbroker()
Returns the name of the DocBroker in use when the object was written to
the registry.
|
java.lang.String |
getDomainName()
Returns the NT domain name of the user who registered this document.
|
java.lang.String |
getFilePath()
Returns the local content file path to the repository object.
|
java.lang.String |
getFolderPath()
Returns the repository cabinet / folder path from which the repository object
was accessed when the object was added to the registry.
|
java.lang.String |
getFormat()
Returns the format name for the repository object (for example, msw6)
|
java.lang.String |
getFormatDescription()
Returns the description of the repository format for the object (e.g.
|
java.lang.String |
getObjectId()
Returns the repository object ID for the client registry object.
|
java.lang.String |
getObjectName()
Returns the name of the repository object.
|
java.lang.String |
getResourceForkIdentifier()
Returns resource fork identifier
|
java.lang.String |
getTitle()
Returns the title of the repository object.
|
java.lang.String |
getType()
Returns the r_object_type for the repository object.
|
java.lang.String |
getUser()
Returns the login name of the user who registered this document.
|
int |
getVStamp()
Returns the vstamp of the object.
|
boolean |
isDirty()
Returns true if the object attributes have been modified.
|
void |
loadFromRegistry(java.lang.String objId)
Reads the information from the registry into the object
|
void |
setContentIdentifier(java.lang.String contentIdentifier)
Sets content identifier
|
void |
setDocbaseId(java.lang.String docbaseId)
Sets the ID of the repository the object resides on
|
void |
setDocbaseName(java.lang.String docbaseName)
Sets the name of the repository the object resides on
|
void |
setDocbroker(java.lang.String docbroker)
Sets the name of the DocBroker the user is using
|
void |
setDomainName(java.lang.String domainName)
Sets the domain name of the object
|
void |
setFilePath(java.lang.String filePath)
Sets the local file path of the object
|
void |
setFolderPath(java.lang.String folderPath)
Sets the folder path of the object in the repository
|
void |
setFormat(java.lang.String format)
Sets the object type of the object
|
void |
setFormatDescription(java.lang.String formatDesc)
Sets the English name of the format of the object
|
void |
setObjectId(java.lang.String objId)
Sets the object ID of the object
|
void |
setObjectName(java.lang.String objName)
Sets the name of the object
|
void |
setResourceForkIdentifier(java.lang.String resourceForkIdentifier)
Sets resource fork identifier
|
void |
setTitle(java.lang.String title)
Sets the title of the checked-out object
|
void |
setType(java.lang.String type)
Sets the object type of the object
|
void |
setUser(java.lang.String user)
Sets the user name of the user that is using the object
|
void |
setVStamp(int vStamp)
Sets the vstamp of the object
|
void |
updateRegistry()
Writes the information in the object to the registry
|
java.lang.String getObjectId()
void setObjectId(java.lang.String objId)
objId
- the new object IDjava.lang.String getObjectName()
void setObjectName(java.lang.String objName)
objName
- the name of the objectjava.lang.String getTitle()
void setTitle(java.lang.String title)
title
- the title of the objectjava.lang.String getFilePath()
void setFilePath(java.lang.String filePath)
filePath
- the local file path of the checked-out objectjava.lang.String getType()
void setType(java.lang.String type)
type
- the object type of the objectjava.lang.String getFormat()
void setFormat(java.lang.String format)
format
- the format of the objectjava.lang.String getFormatDescription()
void setFormatDescription(java.lang.String formatDesc)
formatDesc
- the format description of the objectjava.lang.String getDocbaseId()
void setDocbaseId(java.lang.String docbaseId)
docbaseId
- the ID of the repository the object resides onjava.lang.String getDocbaseName()
void setDocbaseName(java.lang.String docbaseName)
docbaseName
- the name of the repository the object resides onjava.lang.String getDocbroker()
void setDocbroker(java.lang.String docbroker)
docbroker
- the name of the DocBroker the user is usingjava.lang.String getFolderPath()
void setFolderPath(java.lang.String folderPath)
folderPath
- the folder path of the objectjava.lang.String getDomainName()
void setDomainName(java.lang.String domainName)
domainName
- the folder path of the objectjava.lang.String getUser()
void setUser(java.lang.String user)
user
- the user name of the user using the objectint getVStamp()
void setVStamp(int vStamp)
vStamp
- the vstamp of the object.boolean isDirty()
void updateRegistry() throws DfException
DfException
void loadFromRegistry(java.lang.String objId) throws DfException
objId
- the object ID of the object to be readDfException
java.lang.String getContentIdentifier()
void setContentIdentifier(java.lang.String contentIdentifier)
contentIdentifier
- content identifierjava.lang.String getResourceForkIdentifier()
void setResourceForkIdentifier(java.lang.String resourceForkIdentifier)
resourceForkIdentifier
- resource fork identifierCopyright 1994-2023 OpenText Corporation. All rights reserved.