Modifier and Type | Method and Description |
---|---|
void |
delete(String pathName)
Deletes an existing bookmark file.
|
String |
rename(String oldPathName,
String newFileName,
boolean okToOverwriteExistingFile)
Renames an existing bookmark file.
|
void |
saveWithDescription(String pathName,
BasePart.BookmarkOption bookmarkOption,
String description)
Creates a bookmark file including a description.
|
void |
setDescription(String pathName,
String description)
Changes the description of an existing bookmark file.
|
void saveWithDescription(String pathName, BasePart.BookmarkOption bookmarkOption, String description) throws NXException, RemoteException
BasePart.BookmarkOption
for an explanation of the options
which are not supported in batch mode. Also in batch mode, the description is not
written to the bookmark file.
pathName
- Full path name of bookmark file.bookmarkOption
- See definitions of BasePart.BookmarkOption
description
- A text string to be stored in the bookmark fileNXException
RemoteException
String rename(String oldPathName, String newFileName, boolean okToOverwriteExistingFile) throws NXException, RemoteException
oldPathName
- Full path name of existing bookmark file.newFileName
- New name to assign to the bookmark file.
This will replace the basic name in
the oldPathname.okToOverwriteExistingFile
- Is it okay to overwrite an existing file
with the same name as oldPathName plus
newFileName?NXException
RemoteException
void setDescription(String pathName, String description) throws NXException, RemoteException
pathName
- Full path name of an existing bookmark file.description
- A text string to replace the current description in the bookmark fileNXException
RemoteException
void delete(String pathName) throws NXException, RemoteException
pathName
- Full path name of existing bookmark file to deleteNXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.