nxopen.layout2d

Interface PublishComponentBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface PublishComponentBuilder
extends Builder

Represents a Builder for Publish 2D Component functionality which will allow local definitions to be exported into external storage locations
To create a new instance of this class, use ComponentCollection.createPublishComponentBuilder()

Created in NX10.0.0

Method Summary

Modifier and Type	Method and Description
String	destinationPath() Returns the path of folder to publish into License requirements: None.
boolean	isFolder() Returns the type of object to pblish.
Layout2dDefinitionLocation	location() Returns the location type of folder to publish into License requirements: nx_layout ("NX Layout") .
String	originPath() Returns the path of folder or definition to publish License requirements: None.
void	setDestinationPath(String destinationPath) License requirements: nx_layout ("NX Layout") .
void	setFolder(boolean isFolder) License requirements: nx_layout ("NX Layout") .
void	setLocation(Layout2dDefinitionLocation locationType) License requirements: nx_layout ("NX Layout") .
void	setOriginPath(String originPath) License requirements: nx_layout ("NX Layout") .

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

originPath

String originPath()
           throws NXException,
                  RemoteException

Returns the path of folder or definition to publish
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setOriginPath

void setOriginPath(String originPath)
            throws NXException,
                   RemoteException

License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

originPath -

Throws:

NXException

RemoteException

destinationPath

String destinationPath()
                throws NXException,
                       RemoteException

Returns the path of folder to publish into
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setDestinationPath

void setDestinationPath(String destinationPath)
                 throws NXException,
                        RemoteException

License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

destinationPath -

Throws:

NXException

RemoteException

location

Layout2dDefinitionLocation location()
                             throws NXException,
                                    RemoteException

Returns the location type of folder to publish into
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Throws:

NXException

RemoteException

setLocation

void setLocation(Layout2dDefinitionLocation locationType)
          throws NXException,
                 RemoteException

License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

locationType -

Throws:

NXException

RemoteException

isFolder

boolean isFolder()
          throws NXException,
                 RemoteException

Returns the type of object to pblish. Can be definition or folder
License requirements: nx_layout ("NX Layout")

Created in NX10.0.0

Throws:

NXException

RemoteException

setFolder

void setFolder(boolean isFolder)
        throws NXException,
               RemoteException

License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

isFolder -

Throws:

NXException

RemoteException