public interface ShipNameFieldBuilder extends TaggedObject, IComponentBuilder
Fields can be one of four types: 1) Fixed A string with an unchangeable value 2) Any A user entered string value 3) Option A predefined set of strings from which the user can choose one 4) Index A system generated, leading zeros, number which pretends to provide name uniqueness.There may be as many Fixed, Any, and Option fields as the user deems appropriate. There may be only one Index field. The fields for a particular Ship object type
ShipNamesBuilder
are defined in
a "recipes" file which specifies, for a particular object type, the fields and their values.
See ShipNamesRecipes.xml in UGII_BASE_DIR/nxship/data for details on the recipes.
A sample recipe might be defined having the following fields: Type Value -------- -------- Fixed "TBH-" Option "Port", "Starboard", "None" Fixed "-" Index nnnnnn
Modifier and Type | Method and Description |
---|---|
String[] |
getOptionValues()
Get the valid option values for an Option type field.
|
void |
setValue(String newValue)
License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") . |
String |
value()
Returns the field value.
|
printTestData, printTestData, tag, tagValue
validate
String value() throws NXException, RemoteException
NXException
RemoteException
void setValue(String newValue) throws NXException, RemoteException
newValue
- NXException
RemoteException
String[] getOptionValues() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.