public interface BulkReplacementBuilder extends Builder
Modifier and Type | Method and Description |
---|---|
void |
clearAttributeForAllObjects(RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The attribute value clear method for all objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
clearAttributeForObject(NXObject objectTag,
RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The object attribute value clear method
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
copySearchResultsToObject(NXObject fromObjectTag,
NXObject toObjectTag)
The method that copies the search results from one object to another
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String |
getAttributeForObject(NXObject objectTag,
RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The object attribute value method getter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
int |
getPartLayer()
The method that gets the layer used for newly replaced objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String[] |
getPartLibraryValuesForAttributeForObject(NXObject objectTag,
RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The method gets the part libray values for a given attribute for the specified object
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String |
getPartReferenceSet()
The method that gets the reference set used for newly replaced objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
RoutingBulkReplacementBuilderReplacementMethodType |
getReplacementMethodForObject(NXObject objectTag)
The replacement method getter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String |
getReplacementObjectIdentifierForObject(NXObject objectTag)
The replacement object identifier getter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String[] |
getReplacementObjectIdentifiersFromSearchResultsForObject(NXObject objectTag)
The possible replacement object identifiers method getter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
RoutingBulkReplacementBuilderRetainReasonType |
getRetainReasonForObject(NXObject objectTag)
The retain reason getter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String[] |
getSelectedObjectValuesForAttribute(RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The method that retrieves all the values for a given attribute from all the objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String |
getValueForAttributeFromReferenceObject(RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The method that returns the value of an attribute from the reference object
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
SelectNXObject |
referenceObject()
Returns the reference object used to extract characteristics for Bulk Replacement
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
RouteObjectCollector |
routeObjectCollector()
Returns the Routing object collector
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
searchForReplacementForObject(NXObject objectTag)
The method that initiates a search for the replacement object
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
searchForReplacementForObjectOnAttributes(NXObject objectTag,
RoutingAttributeIdentifierType[] attributeIdTypes,
String[] attributeIds)
The method that initiates a search for the replacement object using on the passed in attributes as criteria
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setAttributeForAllObjects(RoutingAttributeIdentifierType attributeIdType,
String attributeId,
String value)
The attribute value setter for all objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setAttributeForObject(NXObject objectTag,
RoutingAttributeIdentifierType attributeIdType,
String attributeId,
String value)
The object attribute value method setter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setAttributeValueForObjectFromReferenceObject(NXObject objectTag,
RoutingAttributeIdentifierType attributeIdType,
String attributeId)
The method that sets the attribute value from the reference object on the specifiec object
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setPartLayer(int layer)
The method that sets the layer used for newly replaced objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setPartReferenceSet(String referenceSetName)
The method that sets the reference set used for newly replaced objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setReplacementClassificationObjectForObject(NXObject objectTag,
String classificationClassId,
String classificationInstanceId)
The replacement object method setter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setReplacementMethodForAllObjects(RoutingBulkReplacementBuilderReplacementMethodType method)
The replacement method setter for all objects
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setReplacementMethodForObject(NXObject objectTag,
RoutingBulkReplacementBuilderReplacementMethodType method)
The replacement method setter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setReplacementObjectIdentifierForObject(NXObject objectTag,
String objectIdentifier)
The replacement object identifier method setter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setReplacementPartSpecificationForObject(NXObject objectTag,
String partSpecification)
The replacement part specification method setter
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setSequenceOfObjectReplacement(NXObject[] objects)
The method that sets the sequence of object replacement
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
RouteObjectCollector routeObjectCollector() throws NXException, RemoteException
NXException
RemoteException
void setReplacementMethodForObject(NXObject objectTag, RoutingBulkReplacementBuilderReplacementMethodType method) throws NXException, RemoteException
objectTag
- The object for which to set the replacement methodmethod
- The replacement method to use for replacement of this objectNXException
RemoteException
void setReplacementMethodForAllObjects(RoutingBulkReplacementBuilderReplacementMethodType method) throws NXException, RemoteException
method
- The replacement method to set for all objectsNXException
RemoteException
RoutingBulkReplacementBuilderReplacementMethodType getReplacementMethodForObject(NXObject objectTag) throws NXException, RemoteException
objectTag
- The object for which to get the replacement methodNXException
RemoteException
RoutingBulkReplacementBuilderRetainReasonType getRetainReasonForObject(NXObject objectTag) throws NXException, RemoteException
objectTag
- The object for which to get the retain reasonNXException
RemoteException
void setReplacementObjectIdentifierForObject(NXObject objectTag, String objectIdentifier) throws NXException, RemoteException
objectTag
- The object for which to set the replacement objectobjectIdentifier
- The object identifier for which to set as the replacement objectNXException
RemoteException
void setReplacementClassificationObjectForObject(NXObject objectTag, String classificationClassId, String classificationInstanceId) throws NXException, RemoteException
objectTag
- The object for which to set the replacement objectclassificationClassId
- The classification object class id of the object to to set as the replacement objectclassificationInstanceId
- The classification object instance id of the object to to set as the replacement objectNXException
RemoteException
void setReplacementPartSpecificationForObject(NXObject objectTag, String partSpecification) throws NXException, RemoteException
objectTag
- The object for which to set the replacement objectpartSpecification
- The full part specification of the part to use for replacementNXException
RemoteException
String getReplacementObjectIdentifierForObject(NXObject objectTag) throws NXException, RemoteException
objectTag
- The object for which to get the replacement objectNXException
RemoteException
String[] getReplacementObjectIdentifiersFromSearchResultsForObject(NXObject objectTag) throws NXException, RemoteException
objectTag
- The object for which to get the possible replacement object identifiersNXException
RemoteException
void setAttributeForObject(NXObject objectTag, RoutingAttributeIdentifierType attributeIdType, String attributeId, String value) throws NXException, RemoteException
objectTag
- The object for which to set the attribute valueattributeIdType
- The type of attribute being setattributeId
- The identifier of the attribute being setvalue
- The new value for the attributeNXException
RemoteException
void setAttributeForAllObjects(RoutingAttributeIdentifierType attributeIdType, String attributeId, String value) throws NXException, RemoteException
attributeIdType
- The type of attribute value being setattributeId
- The identifier of the attribute value being setvalue
- The new value for the attributeNXException
RemoteException
String getAttributeForObject(NXObject objectTag, RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
objectTag
- The object for which to get the attribute valueattributeIdType
- The type of attribute being retrievedattributeId
- The identifier of the attribute value being retrievedNXException
RemoteException
void clearAttributeForObject(NXObject objectTag, RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
objectTag
- The object for which to clear the attribute valueattributeIdType
- The type of attribute being clearedattributeId
- The identifier of the attribute value being clearedNXException
RemoteException
void clearAttributeForAllObjects(RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
attributeIdType
- The type of attribute being clearedattributeId
- The identifier of the attribute value being clearedNXException
RemoteException
String[] getSelectedObjectValuesForAttribute(RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
attributeIdType
- The type of attribute for which to get all the valuesattributeId
- The identifier of the attribute for which to get all the valuesNXException
RemoteException
String[] getPartLibraryValuesForAttributeForObject(NXObject objectTag, RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
objectTag
- The object for which to get the part library valuesattributeIdType
- The type of attribute for which to get the valuesattributeId
- The identifier of the attribute for which to get the valuesNXException
RemoteException
void searchForReplacementForObject(NXObject objectTag) throws NXException, RemoteException
objectTag
- The object for which to initiate the searchNXException
RemoteException
void searchForReplacementForObjectOnAttributes(NXObject objectTag, RoutingAttributeIdentifierType[] attributeIdTypes, String[] attributeIds) throws NXException, RemoteException
objectTag
- The object for which to initiate the searchattributeIdTypes
- The array of attribute types to limit the searchattributeIds
- The array of attribute identifiers to limit the searchNXException
RemoteException
void copySearchResultsToObject(NXObject fromObjectTag, NXObject toObjectTag) throws NXException, RemoteException
fromObjectTag
- The object from which you want to copy the search resultstoObjectTag
- The object to which you want to copy the search resultsNXException
RemoteException
SelectNXObject referenceObject() throws NXException, RemoteException
NXException
RemoteException
String getValueForAttributeFromReferenceObject(RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
attributeIdType
- The type of attribute for which to get the valueattributeId
- The identifier of the attribute for which to get all the valuesNXException
RemoteException
void setAttributeValueForObjectFromReferenceObject(NXObject objectTag, RoutingAttributeIdentifierType attributeIdType, String attributeId) throws NXException, RemoteException
objectTag
- The object for which to set the attribute value from the reference objectattributeIdType
- The type of attribute for which to set the value from the reference objectattributeId
- The identifier of the attribute for which to set the value from the reference objectNXException
RemoteException
void setPartReferenceSet(String referenceSetName) throws NXException, RemoteException
referenceSetName
- The name of the reference setNXException
RemoteException
String getPartReferenceSet() throws NXException, RemoteException
NXException
RemoteException
void setPartLayer(int layer) throws NXException, RemoteException
layer
- The number of the layerNXException
RemoteException
int getPartLayer() throws NXException, RemoteException
NXException
RemoteException
void setSequenceOfObjectReplacement(NXObject[] objects) throws NXException, RemoteException
objects
- The objects in the order of them to be replacedNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.