public interface IDfClientRegistry
Modifier and Type | Method and Description |
---|---|
IDfCheckedOutObject |
addCheckedOutObject(IDfSysObject sysObject,
java.lang.String filePath,
boolean keepLocalFile,
java.lang.String folderPath)
Constructs a DfCheckedOutObject and writes it to the registry
|
void |
addFileToBeDeleted(java.lang.String filePath)
Adds a file to the "to be deleted" list in the registry
|
IDfLocalObject |
addLocalObject(IDfSysObject sysObject,
java.lang.String filePath,
boolean keepLocalFile,
java.lang.String folderPath)
Constructs a DfLocalObject and writes it to the registry
|
IDfViewedObject |
addViewedObject(IDfSysObject sysObject,
java.lang.String filePath,
java.lang.String folderPath)
Constructs a DfViewedObject and writes it to the registry
|
void |
applyModifiedAttrs(IDfSysObject sysObject)
updates a checked-out object's attributes with those from a sysobject
|
IDfCheckedOutObject |
getCheckedOutObjectById(IDfId objectId)
Finds a checked-out file registry object based on object ID
|
IDfCheckedOutObject |
getCheckedOutObjectByPath(java.lang.String filePath)
Finds a checked-out file registry object based on file path
|
IDfList |
getCheckedOutObjects()
Gets all the checked out objects
|
java.lang.String |
getCheckoutDirectory() |
java.lang.String |
getExportDirectory() |
IDfList |
getFilesToBeDeleted()
Gets the list of files to be deleted
|
IDfLocalObject |
getLocalObjectById(IDfId objectId)
Finds a local file registry object based on object ID
|
IDfLocalObject |
getLocalObjectByPath(java.lang.String filePath)
Finds a local file registry object based on object ID
|
IDfList |
getLocalObjects()
Gets all the checked out objects
|
java.lang.String |
getProgramDirectory() |
IDfRegistry |
getRegistry()
Returns the underlying internal registry object.
|
java.lang.String |
getUserDirectory() |
IDfViewedObject |
getViewedObjectById(IDfId objectId)
Finds a viewed file registry object based on object ID
|
IDfViewedObject |
getViewedObjectByPath(java.lang.String filePath)
Finds a viewed file registry object based on file path
|
IDfList |
getViewedObjects()
Gets all the viewed objects
|
void |
moveToCheckedOutFiles(IDfLocalObject object)
Removes a local file and places it in the list of checked-out files.
|
void |
moveToLocalFiles(IDfCheckedOutObject object,
IDfSession session)
Removes a checked out file and places it in the list of local files.
|
void |
removeCheckedOutObject(IDfCheckedOutObject itemToRemove)
Removes a checked-out file object from the registry
|
void |
removeFileToBeDeleted(java.lang.String filePath)
Removes a file from the list of files to be deleted
|
void |
removeLocalObject(IDfLocalObject itemToRemove)
Removes a local object from the registry
|
void |
removeViewedObject(IDfViewedObject itemToRemove)
Removes a viewed object from the registry
|
void |
setCheckoutDirectory(java.lang.String checkoutDir)
Sets in the registry the directory where checked out files will be placed
|
void |
setExportDirectory(java.lang.String exportDir)
Sets in the registry the directory exported files will be written to
|
void |
setProgramDirectory(java.lang.String progDir) |
void |
setUserDirectory(java.lang.String userDir)
Sets in the registry the user's directory
|
IDfRegistry getRegistry()
IDfCheckedOutObject addCheckedOutObject(IDfSysObject sysObject, java.lang.String filePath, boolean keepLocalFile, java.lang.String folderPath) throws DfException
sysObject
- the DfSysObject representing the file to be addedfilePath
- the location of the checked-out filekeepLocalFile
- __REVISIT__folderPath
- the folder path to the object in the repositoryDfException
IDfList getCheckedOutObjects() throws DfException
DfException
IDfCheckedOutObject getCheckedOutObjectById(IDfId objectId) throws DfException
objectId
- DfId object with the id of the object to be foundDfException
IDfCheckedOutObject getCheckedOutObjectByPath(java.lang.String filePath) throws DfException
filePath
- file path of the object to be foundDfException
void removeCheckedOutObject(IDfCheckedOutObject itemToRemove) throws DfException
itemToRemove
- DfCheckedOutObject to removeDfException
IDfViewedObject addViewedObject(IDfSysObject sysObject, java.lang.String filePath, java.lang.String folderPath) throws DfException
sysObject
- the DfSysObject representing the file to be addedfilePath
- the location of the checked-out filefolderPath
- the folder path to the object in the repositoryDfException
IDfList getViewedObjects() throws DfException
DfException
IDfViewedObject getViewedObjectById(IDfId objectId) throws DfException
objectId
- DfId object with the ID of the object to be foundDfException
IDfViewedObject getViewedObjectByPath(java.lang.String filePath) throws DfException
filePath
- DfId object with the ID of the object to be foundDfException
void removeViewedObject(IDfViewedObject itemToRemove) throws DfException
itemToRemove
- the viewed object to be removed from the registryDfException
IDfLocalObject addLocalObject(IDfSysObject sysObject, java.lang.String filePath, boolean keepLocalFile, java.lang.String folderPath) throws DfException
DfException
IDfList getLocalObjects() throws DfException
DfException
IDfLocalObject getLocalObjectById(IDfId objectId) throws DfException
DfException
IDfLocalObject getLocalObjectByPath(java.lang.String filePath) throws DfException
DfException
void removeLocalObject(IDfLocalObject itemToRemove) throws DfException
itemToRemove
- the viewed object to be removed from the registryDfException
void setProgramDirectory(java.lang.String progDir) throws DfException
progDir
- DfException
java.lang.String getProgramDirectory() throws DfException
DfException
void setUserDirectory(java.lang.String userDir) throws DfException
DfException
java.lang.String getUserDirectory() throws DfException
DfException
void setCheckoutDirectory(java.lang.String checkoutDir) throws DfException
checkoutDir
- the checkout directory pathDfException
java.lang.String getCheckoutDirectory() throws DfException
DfException
void setExportDirectory(java.lang.String exportDir) throws DfException
exportDir
- the directory to place exported files inDfException
java.lang.String getExportDirectory() throws DfException
DfException
void addFileToBeDeleted(java.lang.String filePath) throws DfException
filePath
- path of file to be deletedDfException
IDfList getFilesToBeDeleted() throws DfException
DfException
void removeFileToBeDeleted(java.lang.String filePath) throws DfException
filePath
- path of file to be removed from listDfException
void moveToLocalFiles(IDfCheckedOutObject object, IDfSession session) throws DfException
object
- the checked-out object to be movedsession
- the current session objectDfException
void moveToCheckedOutFiles(IDfLocalObject object) throws DfException
object
- the local object to be movedDfException
void applyModifiedAttrs(IDfSysObject sysObject) throws DfException
sysObject
- the sysobject to update the registry object withDfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.