nxopen.validate

Interface RequirementCollection

All Superinterfaces:

Remote

public interface RequirementCollection
extends Remote

Represents an NX RequirementCollection object.
To obtain an instance of this class, refer to BasePart

Created in NX8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RequirementCollection.SourceTypeOptions This enum represents the type of external source where requirement is defined

Method Summary

Modifier and Type	Method and Description
RequirementBuilder	createRequirementBuilder(Requirement requirement) Creates a RequirementBuilder License requirements: None.
Requirement	findObject(String id) Finds the Requirement with the given identifier.
void	loadFromExternalSource(RequirementCollection.SourceTypeOptions sourceType, String source, String revision, String project) Loads Requirement from external source.
void	refreshFromExternalSource(Requirement[] requirementTags) Refreshes the requirements from external source.
String	revisionRule() Returns the revision rule for requirement from Teamcenter License requirements: None.
void	setRevisionRule(String rule) License requirements: None.

Method Detail

createRequirementBuilder

RequirementBuilder createRequirementBuilder(Requirement requirement)
                                     throws NXException,
                                            RemoteException

Creates a RequirementBuilder
License requirements: None.

Created in NX8.5.0

Parameters:

requirement -

Throws:

NXException

RemoteException

findObject

Requirement findObject(String id)
                throws NXException,
                       RemoteException

Finds the Requirement with the given identifier. An exception will be thrown if no object can be found with given identifier.
License requirements: None.

Created in NX8.5.0

Parameters:

id - The identifier of the Requirement

Returns:

Requirement with the identifier

Throws:

NXException

RemoteException

loadFromExternalSource

void loadFromExternalSource(RequirementCollection.SourceTypeOptions sourceType,
                            String source,
                            String revision,
                            String project)
                     throws NXException,
                            RemoteException

Loads Requirement from external source. The source can be local file, Teamcenter requirement item or item revision, and Teamcenter spreadsheet dataset for which the input sourceType is LocalFile, Teamcenter and TeamcenterFile respectively.
Example inputs when sourceType is LocalFile

1. source: "C:\requirement.xml" or "C:\requirement_spreadsheet.xls"
2. revision: empty string
3. project: "category_A" It's a project node name in the source XML file or a sheet name in the source spreadsheet file.

Example inputs when sourceType is Teamcenter

If source is item revision 000084/A:
1. source: "000084"
2. revision: "A"
3. project: empty string

If source is item 000084:
1. source: "000084"
2. revision:empty string
3. project: empty string

Example inputs when sourceType is TeamcenterFile

If source is a spreadsheet dataset in an item revision 000085/A:
1. source: 000085
2. revision: A
3. project: "category_A" It's a sheet name in the source spreadsheet.

If source is a spreadsheet dataset in item 000085:
1. source: "000085"
2. revision: empty string
3. project: "category_A" It's a sheet name in the source spreadsheet.

License requirements: None.

Created in NX8.5.0

Parameters:

sourceType - Type of the external source

source - File full path if sourceType is LocalFile; Item id if sourceType is Teamcenter or TeamcenterFile.

revision - Only needed if sourceType is Teamcenter or TeamcenterFile. Revision id if source is an item revision. Null if source is an item.

project - Required if sourceType is LocalFile or TeamcenterFile. Project name if the source is a XML file; Sheet name if source is a spreadsheet file.

Throws:

NXException

RemoteException

revisionRule

String revisionRule()
             throws NXException,
                    RemoteException

Returns the revision rule for requirement from Teamcenter
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setRevisionRule

void setRevisionRule(String rule)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

rule -

Throws:

NXException

RemoteException

refreshFromExternalSource

void refreshFromExternalSource(Requirement[] requirementTags)
                        throws NXException,
                               RemoteException

Refreshes the requirements from external source.
License requirements: None.

Created in NX10.0.0

Parameters:

requirementTags -

Throws:

NXException

RemoteException