nxopen.pdm

Interface PartFromPartBuilder

All Superinterfaces:

PartBuilder, Remote, TransientObject

public interface PartFromPartBuilder
extends PartBuilder

This class provides the methods necessary to create a new part in NX Manager from an existing part.
This class is deprecated in NX10 for "Save As of master parts" operation. This class should only be used in case of Save As Non Master parts and Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder . This class will not support Save As if there are duplicate item ids in database.

The operation that this builder supports is equivalent to the file save as operation which can:

1. Copy a non-master dataset into a previously existing item revision,
2. Save a master dataset (and possibly non-master datasets) into a new revision of the same item,
3. Save any master or non-master dataset as a completely new item.

The part that is saved is always the work part. If the save is successful, then the newly saved part will be the display part.

This class is a singleton meaning only one instance of it can be exist at a time.

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PartFromPartBuilder.FileSaveAs This enum is used to specify which non-master parts and dependent files should be saved during the save as operation.

Nested classes/interfaces inherited from interface nxopen.pdm.PartBuilder

PartBuilder.Operation, PartBuilder.PartFileNameData, PartBuilder.PartNumberData, PartBuilder.PartRevisionData

Method Summary

Modifier and Type	Method and Description
void	commit() Creates the new part that has been fully-specified by calling methods on this builder.
void	createNonmasterList() Initializes the list of non-master parts that can be saved during the save as operation.
PartFromPartBuilder.FileSaveAs	dependentFileSaveAsOption() Returns the dependent files to save during the save as operation Deprecated in NX10 for "Save As of master parts" operation.
boolean	editNonmasterNameToSaveAs(String oldName, String newName) Sets the name the non-master part will get saved as.
String[]	getNonmasterList() Gets the list of non-master parts.
boolean	getNonmasterToSaveAs(String partName) Returns whether or not the non-master part specified will actually get saved during the save as operation.
PartFromPartBuilder.FileSaveAs	nonmasterSaveAsOption() Returns the non-master parts to save during the save as operation Deprecated in NX10 for "Save As of master parts" operation.
void	setDependentFileSaveAsOption(PartFromPartBuilder.FileSaveAs saveOption) Sets the dependent files to save during the save as operation Deprecated in NX10 for "Save As of master parts" operation.
void	setNonmasterSaveAsOption(PartFromPartBuilder.FileSaveAs saveOption) Sets the non-master parts to save during the save as operation Deprecated in NX10 for "Save As of master parts" operation.
void	setNonmasterToSaveAs(String partName, boolean doSaveAs) Sets whether or not the non-master part specified will actually get saved during the save as operation.

Methods inherited from interface nxopen.pdm.PartBuilder

assignPartFileName, assignPartFileName, assignPartNumber, assignPartNumber, assignPartRevision, assignPartRevision, createPartCreationObject, createPartSpec, newAlternateIdManager, newDatabaseAttributeManager, setAssignPartNumber, setAssignPartType, setContextOperation

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

setNonmasterSaveAsOption

void setNonmasterSaveAsOption(PartFromPartBuilder.FileSaveAs saveOption)
                       throws NXException,
                              RemoteException

Sets the non-master parts to save during the save as operation
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.getCopyNonMasterPartsOption(nxopen.pdm.LogicalObject) .

License requirements: None.

Created in NX4.0.0

Parameters:

saveOption -

Throws:

NXException

RemoteException

nonmasterSaveAsOption

PartFromPartBuilder.FileSaveAs nonmasterSaveAsOption()
                                              throws NXException,
                                                     RemoteException

Returns the non-master parts to save during the save as operation
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.getCopyNonMasterPartsOption(nxopen.pdm.LogicalObject) .

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setDependentFileSaveAsOption

void setDependentFileSaveAsOption(PartFromPartBuilder.FileSaveAs saveOption)
                           throws NXException,
                                  RemoteException

Sets the dependent files to save during the save as operation
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.dependentFilesToCopyOption() .

License requirements: None.

Created in NX4.0.0

Parameters:

saveOption -

Throws:

NXException

RemoteException

dependentFileSaveAsOption

PartFromPartBuilder.FileSaveAs dependentFileSaveAsOption()
                                                  throws NXException,
                                                         RemoteException

Returns the dependent files to save during the save as operation
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.dependentFilesToCopyOption() .

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

createNonmasterList

void createNonmasterList()
                  throws NXException,
                         RemoteException

Initializes the list of non-master parts that can be saved during the save as operation.
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.createNonMasterListForCopyLogicalObject(nxopen.pdm.LogicalObject) .

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

getNonmasterList

String[] getNonmasterList()
                   throws NXException,
                          RemoteException

Gets the list of non-master parts.
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.getNonMasterListForCopyLogicalObject(nxopen.pdm.LogicalObject) .

License requirements: None.

Created in NX8.5.0

Returns:

Non-master part file names

Throws:

NXException

RemoteException

getNonmasterToSaveAs

boolean getNonmasterToSaveAs(String partName)
                      throws NXException,
                             RemoteException

Returns whether or not the non-master part specified will actually get saved during the save as operation.
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.isNonMasterForLogicalObjectBeingCopied(nxopen.pdm.LogicalObject, java.lang.String) .

License requirements: None.

Created in NX4.0.0

Parameters:

partName - the non-master part that the caller wants to save or not save

Returns:

True means that this non-master will be saved. False means that this non-master will not be saved.

Throws:

NXException

RemoteException

setNonmasterToSaveAs

void setNonmasterToSaveAs(String partName,
                          boolean doSaveAs)
                   throws NXException,
                          RemoteException

Sets whether or not the non-master part specified will actually get saved during the save as operation. True means that it will be saved. False means that it will not be saved.
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.setSelectedNonMasterToCopy(nxopen.pdm.LogicalObject, java.lang.String) .

License requirements: None.

Created in NX4.0.0

Parameters:

partName - the non-master part whose save option is being set here

doSaveAs - True means that this non-master part will be saved. False means that this non-master part will not be saved.

Throws:

NXException

RemoteException

editNonmasterNameToSaveAs

boolean editNonmasterNameToSaveAs(String oldName,
                                  String newName)
                           throws NXException,
                                  RemoteException

Sets the name the non-master part will get saved as. It will get saved as the original non-master name if this method is not called.
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use PartOperationCopyBuilder.editNonMasterToCopyName(nxopen.pdm.LogicalObject, java.lang.String, java.lang.String) .

License requirements: None.

Created in NX4.0.0

Parameters:

oldName - the non-master part whose save as name is being set here

newName - the new name

Returns:

Whether or not the name is a valid data set name. The name will get set on the builder no matter if it is valid or not.

Throws:

NXException

RemoteException

commit

void commit()
     throws NXException,
            RemoteException

Creates the new part that has been fully-specified by calling methods on this builder.
Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As Non Master parts and Save As New Item Type Operations. For Save As of master parts, use Builder.commit() instead.

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException