public interface SubsetBuilder extends Builder, IAttributeSourceObjectBuilder
Subset
.
SubsetCollection.createSubsetBuilder(nxopen.assemblies.Subset)
Modifier and Type | Method and Description |
---|---|
boolean |
addAllSubordinates()
Returns the value which determines whether the subset will include all the subordinates of reuse design elements.
|
CollaborativeDesign |
collaborativeDesign()
Returns the
CollaborativeDesign of the subset. |
ConfigurationContextBuilder |
configurationContext()
Returns the configuration context builder.
|
ContentDefinition |
contentDefinition()
Returns the
ContentDefinition used to define the context of the subset creation. |
FindInCollaborativeDesign |
finder()
Returns the
FindInCollaborativeDesign for use in the context
determined by this builder. |
NXObject |
findObject(String journalIdentifier)
Finds the
NXObject with the given identifier as recorded in a journal. |
void |
generateResults()
Generate the search results for the
Subset according to the current
SubsetRecipe . |
LogicalObject[] |
getSubsetLogicalObjects()
Returns subset logical objects created by builder.
|
Subset[] |
getSubsets()
Returns subsets held / created by this builder.
|
SubsetRecipe |
recipe()
Returns the
SubsetRecipe that contains the SearchTerm s
used to generate the contents of the subset
Created in NX8.5.0 |
SearchResultCollection |
searchResults()
Returns the
SearchResultCollection that contains current search results
associated with this subset builder. |
void |
setAddAllSubordinates(boolean addAllSubordinates)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setCollaborativeDesign(CollaborativeDesign collaborativeDesign)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setContentDefinition(ContentDefinition contentDefinition)
License requirements: nx_4gd_integration ("4th Generation Design") . |
void |
setSubsetDescription(String description)
Deprecated.
Deprecated in NX11.0.0. Use
LogicalObject properties instead.
|
void |
setSubsetName(String name)
Deprecated.
Deprecated in NX11.0.0. Use
LogicalObject properties instead.
|
void |
setViewedPartitionScheme(PartitionScheme partitionScheme)
License requirements: nx_4gd_integration ("4th Generation Design") . |
Subset |
subset()
Deprecated.
Deprecated in NX11.0.0. Please use
getSubsets() instead.
|
SubsetConfigurationBuilder |
subsetConfiguration()
Deprecated.
Deprecated in NX9.0.0. Use
configurationContext() instead.
|
String |
subsetDescription()
Deprecated.
Deprecated in NX11.0.0. Use
LogicalObject properties instead.
|
String |
subsetName()
Deprecated.
Deprecated in NX11.0.0. Use
LogicalObject properties instead.
|
Subset.ContentType |
subsetType()
Returns the type of PLM object used to create subset.
|
BasicEffectivityBuilder |
targetEffectivity()
Deprecated.
Deprecated in NX9.0.0. Use
targetEffectivityTable() instead.
|
EffectivityTableBuilder |
targetEffectivityTable()
Returns the
EffectivityTableBuilder used to edit the target effectivity of the subset. |
PartitionList |
targetPartitionList()
Returns the default target
Partition s for design elements created within the subset. |
void |
updateConfigurationContext(LogicalObject logicalObject)
Updates revision rule, effectivity and variant information on subset logical object of subset builder.
|
void |
updateSubsetConfigurationOfDependentSubset()
Updates revision rule, effectivity information on the dependent subsets if any.
|
void |
updateSubsetTargetPropertiesOfDependentSubset()
Updates target effectivity information on the dependent subsets if any.
|
PartitionScheme |
viewedPartitionScheme()
Returns the viewed
PartitionScheme of the subset. |
ComponentAssembly |
workset()
Returns the
ComponentAssembly within which we are
building an Subset . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
autoAssignAttributes, autoAssignAttributesWithNamingPattern, createAttributeTitleToNamingPatternMap
SearchResultCollection searchResults() throws RemoteException
SearchResultCollection
that contains current search results
associated with this subset builder.
SearchResults will be populated with the existing subset contents when the builder is created to
edit a subset. These are replaced with results found by the last call to generateResults()
after that method is first called.
In addition, the last results from finder()
are included in this
collection.
RemoteException
SubsetRecipe recipe() throws RemoteException
SubsetRecipe
that contains the SearchTerm
s
used to generate the contents of the subset
RemoteException
ComponentAssembly workset() throws NXException, RemoteException
ComponentAssembly
within which we are
building an Subset
.
NXException
RemoteException
Subset subset() throws NXException, RemoteException
getSubsets()
instead.
Subset
that we are building.
NXException
RemoteException
Subset[] getSubsets() throws NXException, RemoteException
NXException
RemoteException
void generateResults() throws NXException, RemoteException
Subset
according to the current
SubsetRecipe
.
NXException
RemoteException
FindInCollaborativeDesign finder() throws NXException, RemoteException
FindInCollaborativeDesign
for use in the context
determined by this builder.
NXException
RemoteException
SubsetConfigurationBuilder subsetConfiguration() throws NXException, RemoteException
configurationContext()
instead.
NXException
RemoteException
ConfigurationContextBuilder configurationContext() throws NXException, RemoteException
NXException
RemoteException
String subsetDescription() throws NXException, RemoteException
LogicalObject
properties instead.
Subset
.
NXException
RemoteException
void setSubsetDescription(String description) throws NXException, RemoteException
LogicalObject
properties instead.
description
- NXException
RemoteException
String subsetName() throws NXException, RemoteException
LogicalObject
properties instead.
Subset
.
NXException
RemoteException
void setSubsetName(String name) throws NXException, RemoteException
LogicalObject
properties instead.
name
- NXException
RemoteException
boolean addAllSubordinates() throws NXException, RemoteException
NXException
RemoteException
void setAddAllSubordinates(boolean addAllSubordinates) throws NXException, RemoteException
addAllSubordinates
- NXException
RemoteException
NXObject findObject(String journalIdentifier) throws NXException, RemoteException
NXObject
with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of
the software. However newer versions of the software should find the same object when
FindObject is passed older versions of its journal identifier. In general, this method
should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier
- Identifier of the NXObject
to be foundNXException
RemoteException
CollaborativeDesign collaborativeDesign() throws NXException, RemoteException
CollaborativeDesign
of the subset.
NXException
RemoteException
void setCollaborativeDesign(CollaborativeDesign collaborativeDesign) throws NXException, RemoteException
collaborativeDesign
- NXException
RemoteException
ContentDefinition contentDefinition() throws NXException, RemoteException
ContentDefinition
used to define the context of the subset creation.
NXException
RemoteException
void setContentDefinition(ContentDefinition contentDefinition) throws NXException, RemoteException
contentDefinition
- NXException
RemoteException
BasicEffectivityBuilder targetEffectivity() throws NXException, RemoteException
targetEffectivityTable()
instead.
BasicEffectivityBuilder
used to edit the target effectivity of the subset.
NXException
RemoteException
EffectivityTableBuilder targetEffectivityTable() throws NXException, RemoteException
EffectivityTableBuilder
used to edit the target effectivity of the subset.
NXException
RemoteException
PartitionList targetPartitionList() throws NXException, RemoteException
Partition
s for design elements created within the subset.
NXException
RemoteException
PartitionScheme viewedPartitionScheme() throws NXException, RemoteException
PartitionScheme
of the subset.
NXException
RemoteException
void setViewedPartitionScheme(PartitionScheme partitionScheme) throws NXException, RemoteException
partitionScheme
- NXException
RemoteException
LogicalObject[] getSubsetLogicalObjects() throws NXException, RemoteException
NXException
RemoteException
Subset.ContentType subsetType() throws NXException, RemoteException
NXException
RemoteException
void updateConfigurationContext(LogicalObject logicalObject) throws NXException, RemoteException
logicalObject
- NXException
RemoteException
void updateSubsetConfigurationOfDependentSubset() throws NXException, RemoteException
NXException
RemoteException
void updateSubsetTargetPropertiesOfDependentSubset() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.