wt.workflow.requirement
Class StandardRequirementService

java.lang.Object
  extended bywt.services.StandardManager
      extended bywt.workflow.requirement.StandardRequirementService
All Implemented Interfaces:
Manager, NetFactor, RequirementService, RequirementServiceSvr, Serializable

public class StandardRequirementService
extends StandardManager
implements RequirementService, RequirementServiceSvr, Serializable

Standard implementation of the requirement service interfaces

Use the newStandardRequirementService static factory method(s), not the StandardRequirementService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  InfoEngine ieService
           
private static String RESOURCE
           
 
Fields inherited from class wt.services.StandardManager
 
Fields inherited from interface wt.services.Manager
MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE
 
Constructor Summary
StandardRequirementService()
           
 
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
protected  String getAuthorization(URL url)
          Get the authorization string that allows the user to access a specified URL.
 String getConceptualClassname()
          Deprecated.  
protected  String getDefaultAuthorization(String realm)
          Get the default authorization string that allows the user to access a specified URL.
private  String getDoorsAdapterInstance(String actionName)
          Gets the doors adapter instance name from the resource file, there could be more than one.
protected  String getHTTPServiceURL()
          Returns the http to the web server

Supported API: false
 InfoEngine getIeService()
          Gets the value of the attribute: ieService; Instance of the Info*Engine Service.
 String getIEServiceUrl()
          Returns the url to the Info*Engine service as specified in ie.properties.
protected  Vector getInfoEngineObjects(InputStream is)
          Retrieves Objects assocatied with the InputStream.
 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.
static StandardRequirementService newStandardRequirementService()
          Default factory for the class.
 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.
 void setIeService(InfoEngine a_IeService)
          Sets the value of the attribute: ieService; Instance of the Info*Engine Service.
 
Methods inherited from class wt.services.StandardManager
emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, performStartupProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

ieService

private InfoEngine ieService
Constructor Detail

StandardRequirementService

public StandardRequirementService()
Method Detail

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Overrides:
getConceptualClassname in class StandardManager
Returns:
String

getIeService

public InfoEngine getIeService()
Gets the value of the attribute: ieService; Instance of the Info*Engine Service. The class InfoEngine entends the Info*Engine Server Access Kit (SAK). It provides additional functionality that facilitates interaction between JSP pages and InfoEngine.

Supported API: false

Returns:
InfoEngine

setIeService

public void setIeService(InfoEngine a_IeService)
                  throws WTPropertyVetoException
Sets the value of the attribute: ieService; Instance of the Info*Engine Service. The class InfoEngine entends the Info*Engine Server Access Kit (SAK). It provides additional functionality that facilitates interaction between JSP pages and InfoEngine.

Supported API: false

Parameters:
a_IeService -
Throws:
WTPropertyVetoException

newStandardRequirementService

public static StandardRequirementService newStandardRequirementService()
                                                                throws WTException
Default factory for the class.

Supported API: false

Returns:
StandardRequirementService
Throws:
WTException

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

Specified by:
removeRequirementAssociation in interface RequirementService
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

Specified by:
getRequirementAssociations in interface RequirementService
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

Specified by:
addRequirementAssociation in interface RequirementService
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

Specified by:
addWcObjectAssociation in interface RequirementService
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

Specified by:
removeWcObjectAssociation in interface RequirementService
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

Specified by:
getWcObjects in interface RequirementService
Returns:
Vector
Throws:
RequirementException
WTException

queryProjects

public Vector queryProjects(String searchString)
                     throws IOException,
                            RequirementException,
                            WTException
Query the Doors database for projects.

Supported API: false

Specified by:
queryProjects in interface RequirementService
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

Specified by:
queryModules in interface RequirementService
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

Specified by:
queryRequirementObjects in interface RequirementService
Parameters:
projectName -
moduleName -
searchString -
Returns:
Vector
Throws:
RequirementException
WTException

authenticate

public void authenticate()
                  throws WTException


Supported API: false

Specified by:
authenticate in interface RequirementService
Throws:
WTException

getAuthorization

protected String getAuthorization(URL url)
                           throws WTException
Get the authorization string that allows the user to access a specified URL. If unable to determine the principal or users credentials, then will call getDefaultAuthorization.

Supported API: false

Parameters:
url - URL for which authorization information is requested
Returns:
String
Throws:
WTException

getDefaultAuthorization

protected String getDefaultAuthorization(String realm)
                                  throws WTException
Get the default authorization string that allows the user to access a specified URL. Found in FederationProperties wt.federation.defaultAuthorization

Supported API: false

Parameters:
realm -
Returns:
String
Throws:
WTException

getInfoEngineObjects

protected Vector getInfoEngineObjects(InputStream is)
                               throws RequirementException,
                                      WTException
Retrieves Objects assocatied with the InputStream. Typically objects from an XML query.

Supported API: false

Parameters:
is - The InputStream that represents the HTTPRequest for the XML object
Returns:
Vector
Throws:
RequirementException
WTException

getHTTPServiceURL

protected String getHTTPServiceURL()
                            throws WTException
Returns the http to the web server

Supported API: false

Returns:
String
Throws:
WTException

getDoorsAdapterInstance

private String getDoorsAdapterInstance(String actionName)
Gets the doors adapter instance name from the resource file, there could be more than one.

Parameters:
actionName -
Returns:
String

getIEServiceUrl

public String getIEServiceUrl()
                       throws RequirementException,
                              IOException
Returns the url to the Info*Engine service as specified in ie.properties.

Supported API: false

Specified by:
getIEServiceUrl in interface RequirementServiceSvr
Returns:
String
Throws:
RequirementException
IOException