wt.workflow.requirement
Interface RequirementService

All Known Implementing Classes:

RequirementServiceFwd, StandardRequirementService

public interface RequirementService

Supported API: false

Extendable: false

Method Summary

void	addRequirementAssociation(WTObject wcObject) RequirementException, WTException Supported API: false
void	addWcObjectAssociation(WTObject wcObject) Associate a requirement object to a Windchill object.
void	authenticate() Supported API: false
Vector	getRequirementAssociations(WTObject wcObject) Returns the requirements associated to a specified object.
Vector	getWcObjects() Returns list of Windchill objects associated to a specified requirement object.
Vector	queryModules(String projectName, String searchString) Returns the Doors modules of a project from the Doors database.
Vector	queryProjects(String searchString) Query the Doors database for projects.
Vector	queryRequirementObjects(String projectName, String moduleName, String searchString) Returns requirement objects of a module.
void	removeRequirementAssociation(WTObject wcObject) Removes the requirement reqObject from the Windchill object wcObject.
void	removeWcObjectAssociation(WTObject wcObject) Removes the requirement reqObject from the Windchill object wcObject.

Method Detail

removeRequirementAssociation

public void removeRequirementAssociation(WTObject wcObject)
                                  throws RequirementException,
                                         WTException

Removes the requirement reqObject from the Windchill object wcObject. If reqObject is not associated with wcObject RequirementException will be thrown.

Supported API: false

Parameters:

wcObject - Windchill object from which the requirement should be removed.

Currently, only WTPart and WTDocument are supported.

Throws:

RequirementException

WTException

getRequirementAssociations

public Vector getRequirementAssociations(WTObject wcObject)
                                  throws RequirementException,
                                         WTException

Returns the requirements associated to a specified object. The returned vector holds objects of the type RequirementObject. Method returns null, if no requirement objects are associated.

Supported API: false

Parameters:

wcObject - The Windchill object.

Currently, only WTPart and WTDocument are supported.

Returns:

Vector

Throws:

RequirementException

WTException

addRequirementAssociation

public void addRequirementAssociation(WTObject wcObject)
                               throws WTException

RequirementException, WTException

Supported API: false

Parameters:

wcObject - Windchill object to which the requirement object object should be added.

Currently, only WTDocumentMaster or WTPartMaster are supported.

Throws:

WTException

addWcObjectAssociation

public void addWcObjectAssociation(WTObject wcObject)
                            throws WTException

Associate a requirement object to a Windchill object.

Supported API: false

Parameters:

wcObject -

Throws:

WTException

removeWcObjectAssociation

public void removeWcObjectAssociation(WTObject wcObject)
                               throws RequirementException,
                                      WTException

Removes the requirement reqObject from the Windchill object wcObject. If reqObject is not associated to wcObject a RequirementException will be thrown

Supported API: false

Parameters:

wcObject - Windchill object, which is associated with the requirement reqObject.

Throws:

RequirementException

WTException

getWcObjects

public Vector getWcObjects()
                    throws RequirementException,
                           WTException

Returns list of Windchill objects associated to a specified requirement object. The returned vector holds objects of the type WTObject. Method returns null, if no WTObjects are associated.

Supported API: false

Returns:

Vector

Throws:

RequirementException

WTException

queryProjects

public Vector queryProjects(String searchString)
                     throws IOException,
                            RequirementException,
                            WTException

Query the Doors database for projects.

Supported API: false

Parameters:

searchString - Search string. Pass empty string or null if all projects should be returned.

Returns:

Vector

Throws:

IOException

RequirementException

WTException

queryModules

public Vector queryModules(String projectName,
                           String searchString)
                    throws RequirementException,
                           IOException,
                           WTException

Returns the Doors modules of a project from the Doors database.

Supported API: false

Parameters:

projectName - Name of the project to query on.

searchString - Search String. Pass empty string or null if all modules should be returned

Returns:

Vector

Throws:

RequirementException

IOException

WTException

queryRequirementObjects

public Vector queryRequirementObjects(String projectName,
                                      String moduleName,
                                      String searchString)
                               throws RequirementException,
                                      WTException

Returns requirement objects of a module.

Supported API: false

Parameters:

projectName -

moduleName -

searchString -

Returns:

Vector

Throws:

RequirementException

WTException

authenticate

public void authenticate()
                  throws WTException

Supported API: false

Throws:

WTException