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

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

public class WDDeployableObjectPart

extends java.lang.Object

WDDeployableObjectPart represents the content of a Web Dynpro deployment unit, like applications, components, configurations or component interfaces. There is always exactly one deployable object related to a deployable object part.

Constructor Summary

WDDeployableObjectPart(java.lang.String deployableObjectName)
Constructs a WDDeployableObejctPart that represents a part of type WDDeployableObjectPart.WEB_RESOURCE.

WDDeployableObjectPart(java.lang.String deployableObjectName, java.lang.String name, java.lang.String shortName, WDDeployableObjectPartType type)
Constructs a WDDeployableObjectPart representing a deployable object part with the specified name, short name and type, that is contained within the deployable object deployableObjectName.

Method Summary

java.util.Collection	getAliases() Return is the collection of defined aliases.
IWDDeployableObject	getDeployableObject() Return is the deployable object to which the current deployable object part belongs.
java.lang.String	getDeployableObjectName() Returns the deployableObjectName.
java.lang.String	getName() Returns the partName.
java.lang.String	getShortName() Returns the shortName.
WDDeployableObjectPartType	getType() Returns the partType.
WDDeployableObjectPart	resolveAlias(java.lang.String alias) Resolves the specified alias.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WDDeployableObjectPart

public WDDeployableObjectPart(java.lang.String deployableObjectName,
                              java.lang.String name,
                              java.lang.String shortName,
                              WDDeployableObjectPartType type)

Constructs a WDDeployableObjectPart representing a deployable object part with the specified name, short name and type, that is contained within the deployable object deployableObjectName.

Parameters:

deployableObjectName - the name of the deployable object

name - the name of the part to be created

shortName - the short name of the deployable object part

type - the part type

Throws:

NullPointerException - if deployable object name, name or type is null or the empty string

WDDeployableObjectPart

public WDDeployableObjectPart(java.lang.String deployableObjectName)

Constructs a WDDeployableObejctPart that represents a part of type WDDeployableObjectPart.WEB_RESOURCE. The constructor new WDDeployableObectPart(deployableObjectName, "", WDDeployableObjectPartType.WEB_RESOURCE) creates the same object.

Parameters:

deployableObjectName - the name of the deployable object

Throws:

NullPointerException - if deployableObjectName is null or the empty string

Method Detail

resolveAlias

public WDDeployableObjectPart resolveAlias(java.lang.String alias)
                                    throws WDAliasResolvingException

Resolves the specified alias. An alias is a logical name for a specified application within a certain deployable object and can be defined in the configuration.

Parameters:

alias - the alias that should be resolved

Returns:

the deployable object that is described by the alias

Throws:

WDAliasResolvingException - if the alias cannot be resolved

getDeployableObjectName

public java.lang.String getDeployableObjectName()

Returns the deployableObjectName.

Returns:

the name of the deployable object

getDeployableObject

public IWDDeployableObject getDeployableObject()

Return is the deployable object to which the current deployable object part belongs.

Returns:

the deployable object to which the current deployable object part belongs

getName

public java.lang.String getName()

Returns the partName.

Returns:

the name of the deployable object part

getType

public WDDeployableObjectPartType getType()

Returns the partType.

Returns:

the type of the deployable object part

getShortName

public java.lang.String getShortName()

Returns the shortName.

Returns:

the short name of the deployable object part

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getAliases

public java.util.Collection getAliases()

Return is the collection of defined aliases. Currently the method is not implemented and returns null.

Returns:

the collection of defined aliases; currently, the method is not implemented and null is returned