com.sap.tc.webdynpro.services.sal.deployment.api
Class WDDeployableObject

java.lang.Object
  |
  +--com.sap.tc.webdynpro.services.sal.deployment.api.WDDeployableObject

public abstract class WDDeployableObject

extends java.lang.Object

WDDeployableObject provides static methods to access an IWDDeployableObject instance. Such an object represents a Web Dynpro deployment unit. It does not represent deployment units of other types (e.g. like Web application).

Example: An IWDDeployableObject object can be accessed as follows:

 // let objectName be the name of the deployable object 
 IWDDeployableObject deployableObject = WDDeployableObject.getDeployableObject(objectName); 
 

See Also:

IWDDeployableObject

Constructor Summary

WDDeployableObject()

Method Summary

static IWDDeployableObject	getDeployableObject(java.lang.String objectName) Returns the deployable object for the object specified by the given objectName.
static WDDeployableObjectPart	getDeployableObjectPart(java.lang.String objectName, java.lang.String partName, WDDeployableObjectPartType partType) Returns a deployable object part description for the specified object part.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WDDeployableObject

public WDDeployableObject()

Method Detail

getDeployableObject

public static IWDDeployableObject getDeployableObject(java.lang.String objectName)

Returns the deployable object for the object specified by the given objectName.

Parameters:

objectName - the name of the deployable object

Returns:

the deployable object for the object specified by the given objectName

Throws:

WDRuntimeException - if there is no deployable object deployed on the server for the given name that represents a Web Dynpro application or if the specified objectName does not represent a deployed Web Dynpro application, but for instance a Web application.

NullPointerException - if objectName is null or the empty String

getDeployableObjectPart

public static WDDeployableObjectPart getDeployableObjectPart(java.lang.String objectName,
                                                             java.lang.String partName,
                                                             WDDeployableObjectPartType partType)
                                                      throws WDDeploymentException

Returns a deployable object part description for the specified object part.

Parameters:

objectName - the name of the deployable object

partName - the name of the deployable object part

partType - the type of the deployable object part

Returns:

the specified deployable object part

Throws:

WDDeplyomentException - if the deployable object part is not deployed correctly or if the part couldn't be found

NullPointerException - if partName is null or empty string or if partType is null