nxopen

Interface Validation

All Superinterfaces:

INXObject, NXObject, Remote, TaggedObject

All Known Subinterfaces:

RequirementCheck

public interface Validation
extends NXObject

Represents an NX Validation object.
To create a new instance of this class, use ValidationCollection.create(java.lang.String, nxopen.Validation.InputType)

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Validation.InputType Specifies the input type
static class	Validation.LookupIntegerData This class holds the data returned from lookupInteger(java.lang.String)
static class	Validation.LookupNumberData This class holds the data returned from lookupNumber(java.lang.String)
static class	Validation.LookupTextData This class holds the data returned from lookupText(java.lang.String)
static class	Validation.LookupTimeData This class holds the data returned from lookupTime(java.lang.String)
static class	Validation.MapType Specifies the map types
static class	Validation.Result Specifies result of the validation
static class	Validation.UpdateTime Specifies when to validate

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
void	add(String key, double number) Add a real to the validation map License requirements: None.
void	add(String key, int number) Add a integer to the validation map License requirements: None.
void	add(String key, int day, int time) Add a time to the validation map License requirements: None.
void	add(String key, NXObject[] objs) Add a objects to the validation map License requirements: None.
void	add(String key, String text) Add a text to the validation map License requirements: None.
void	delete() Delete Validation Object License requirements: None.
Validation.Result	evaluate() Manually validate License requirements: None.
NXObject[]	getAssociatedObjects() Gets associated objects for the check.
Validation.Result	getCheckResult() The validation result.
Validation.Result	getInitialResult() The initial result.
String[]	getKeys() Get keys License requirements: None.
Validation.MapType	getKeyType(String key) Get key type License requirements: None.
boolean	getSuppressed() The suppress state of the validation License requirements: None.
void	information() Information display on a Validation Object License requirements: None.
NXObject[]	lookup(String key) Lookup a objects to the validation map License requirements: None.
Validation.LookupIntegerData	lookupInteger(String key) Lookup a integer to the validation map License requirements: None.
Validation.LookupNumberData	lookupNumber(String key) Lookup a real to the validation map License requirements: None.
Validation.LookupTextData	lookupText(String key) Lookup a text to the validation map License requirements: None.
Validation.LookupTimeData	lookupTime(String key) Lookup a time to the validation map License requirements: None.
void	remove(String key) Remove a key from the map License requirements: None.
void	replace(String key, NXObject[] objs) Replace objects of a key in the validation map License requirements: None.
String	requirement() Returns the requirement path.
void	setAssociatedObjects(NXObject[] objects) Specifies or removes associated objects for the check.
void	setCheckResult(Validation.Result result) Set the result of validation.
void	setRequirement(String requirement) License requirements: None.
void	setSuppressed(boolean suppress) License requirements: None.
void	setUpdateControl(Validation.UpdateTime updateTime) Define the update behavior of the validation object License requirements: None.
void	setUserClassName(String name) Set user class name License requirements: None.

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

setUpdateControl

void setUpdateControl(Validation.UpdateTime updateTime)
               throws NXException,
                      RemoteException

Define the update behavior of the validation object
License requirements: None.

Created in NX4.0.0

Parameters:

updateTime - Sets the time of update

Throws:

NXException

RemoteException

add

void add(String key,
         NXObject[] objs)
  throws NXException,
         RemoteException

Add a objects to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

objs - Objects to be associate with the key

Throws:

NXException

RemoteException

replace

void replace(String key,
             NXObject[] objs)
      throws NXException,
             RemoteException

Replace objects of a key in the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

objs - Objects to be associate with the key

Throws:

NXException

RemoteException

add

void add(String key,
         String text)
  throws NXException,
         RemoteException

Add a text to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

text - Text to be associate with the key

Throws:

NXException

RemoteException

add

void add(String key,
         double number)
  throws NXException,
         RemoteException

Add a real to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

number - Real to be associate with the key

Throws:

NXException

RemoteException

add

void add(String key,
         int number)
  throws NXException,
         RemoteException

Add a integer to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

number - Integer to be associate with the key

Throws:

NXException

RemoteException

add

void add(String key,
         int day,
         int time)
  throws NXException,
         RemoteException

Add a time to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

day - Date to be associated with the key

time - Time to be associate with the key

Throws:

NXException

RemoteException

evaluate

Validation.Result evaluate()
                    throws NXException,
                           RemoteException

Manually validate
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

getCheckResult

Validation.Result getCheckResult()
                          throws NXException,
                                 RemoteException

The validation result. Result is represented as a Name, with the following options: pass : Validation Pass all checks information : Validation Pass with information warning : Validation Pass with warning failed : Validation Failed unknown : Unknown validation result
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setCheckResult

void setCheckResult(Validation.Result result)
             throws NXException,
                    RemoteException

Set the result of validation. Result is represented as a Name, with the following options: pass : Validation Pass all checks information : Validation Pass with information warning : Validation Pass with warning failed : Validation Failed unknown : Unknown validation result
License requirements: None.

Created in NX4.0.0

Parameters:

result -

Throws:

NXException

RemoteException

getKeys

String[] getKeys()
          throws NXException,
                 RemoteException

Get keys
License requirements: None.

Created in NX4.0.0

Returns:

keys in the map

Throws:

NXException

RemoteException

getKeyType

Validation.MapType getKeyType(String key)
                       throws NXException,
                              RemoteException

Get key type
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Throws:

NXException

RemoteException

setUserClassName

void setUserClassName(String name)
               throws NXException,
                      RemoteException

Set user class name
License requirements: None.

Created in NX4.0.0

Parameters:

name - the class name

Throws:

NXException

RemoteException

lookup

NXObject[] lookup(String key)
           throws NXException,
                  RemoteException

Lookup a objects to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Returns:

objects associate with the key

Throws:

NXException

RemoteException

lookupNumber

Validation.LookupNumberData lookupNumber(String key)
                                  throws NXException,
                                         RemoteException

Lookup a real to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Throws:

NXException

RemoteException

lookupText

Validation.LookupTextData lookupText(String key)
                              throws NXException,
                                     RemoteException

Lookup a text to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Throws:

NXException

RemoteException

lookupInteger

Validation.LookupIntegerData lookupInteger(String key)
                                    throws NXException,
                                           RemoteException

Lookup a integer to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Throws:

NXException

RemoteException

lookupTime

Validation.LookupTimeData lookupTime(String key)
                              throws NXException,
                                     RemoteException

Lookup a time to the validation map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Throws:

NXException

RemoteException

remove

void remove(String key)
     throws NXException,
            RemoteException

Remove a key from the map
License requirements: None.

Created in NX4.0.0

Parameters:

key - Map key

Throws:

NXException

RemoteException

getSuppressed

boolean getSuppressed()
               throws NXException,
                      RemoteException

The suppress state of the validation
License requirements: None.

Created in NX4.0.0

Returns:

Supress flag true = supress false unsupress

Throws:

NXException

RemoteException

setSuppressed

void setSuppressed(boolean suppress)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX4.0.0

Parameters:

suppress - Suppress flag true = supress, false = unsupress

Throws:

NXException

RemoteException

getInitialResult

Validation.Result getInitialResult()
                            throws NXException,
                                   RemoteException

The initial result.
License requirements: None.

Created in NX4.0.0

Returns:

result of validation object.

Throws:

NXException

RemoteException

delete

void delete()
     throws NXException,
            RemoteException

Delete Validation Object
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

information

void information()
          throws NXException,
                 RemoteException

Information display on a Validation Object
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

requirement

String requirement()
            throws NXException,
                   RemoteException

Returns the requirement path.
License requirements: None.

Created in NX8.0.0

Returns:

requirement path

Throws:

NXException

RemoteException

setRequirement

void setRequirement(String requirement)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX8.0.0

Parameters:

requirement - requirement path

Throws:

NXException

RemoteException

getAssociatedObjects

NXObject[] getAssociatedObjects()
                         throws NXException,
                                RemoteException

Gets associated objects for the check.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setAssociatedObjects

void setAssociatedObjects(NXObject[] objects)
                   throws NXException,
                          RemoteException

Specifies or removes associated objects for the check.
License requirements: None.

Created in NX8.5.0

Parameters:

objects - Objects to be associated with the check

Throws:

NXException

RemoteException