com.sap.tc.webdynpro.services.sal.deployment.api
Interface IWDDeployableObject

All Superinterfaces:

IWDService

public interface IWDDeployableObject

extends IWDService

IWDDeployableObject specifies the interface of a deployment unit containing Web Dynpro content.
An equivalent term for deployable object is development component (DC).

See Also:

WDDeployableObject

Method Summary

java.lang.String[]	getInterfacesReferences() Return the list of referenced interfaces.
java.lang.String[]	getLibrariesReferences() Return the list of referenced libraries.
java.lang.String	getName() Returns the name of deployable object.
WDDeployableObjectPart[]	getParts() Returns the IWDDeployableObjectPart instances located in the deployable object.
WDDeployableObjectPart[]	getParts(WDDeployableObjectPartType partType) Returns the IWDDeployableObjectPart instances located in the deployable object with the specified part type.
IWDDeployableObject[]	getReferencedDeployableObjects() Return the list of referenced deployable objects.
java.lang.String[]	getServiceReferences() Return the list of referenced services.
java.lang.String[]	getSharingReferences() Return the list of referenced deployable objects.
WDDeployableObjectState	getState() Return is the state of the deployable object.
java.lang.String[]	getUsedJCOClients() Return the list of used JCO clients defined in the actual deployable object.
java.lang.String[]	isReferencedBy() Return the list of deployable objects referencing the actual deployable object.
IWDDeployableObject[]	isReferencedByObjects() Return the list of deployable objects referencing the actual deployable object.
WDDeployableObjectPart	resolveAlias(java.lang.String alias) Resolves the specified alias and return the referenced deployable object part.
WDDeployableObjectPart	resolveAlias(WDDeployableObjectPart part, java.lang.String alias) Resolves the specified alias on the level of the deployable object part contained within the current deployable object and return the referenced deployable object part.

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

getName

public java.lang.String getName()

Returns the name of deployable object.

Returns:

the name of deployable object

getParts

public WDDeployableObjectPart[] getParts()

Returns the IWDDeployableObjectPart instances located in the deployable object.

Returns:

the array of deployable object parts which are located in this deployable object; if no part exists, an array of length 0 is returned

getParts

public WDDeployableObjectPart[] getParts(WDDeployableObjectPartType partType)

Returns the IWDDeployableObjectPart instances located in the deployable object with the specified part type.

Parameters:

partType - the type of the requested deployable object parts

Returns:

the array of deployable object parts; if there exists no deployable object part of the specified partType, an array of length 0 is returned

resolveAlias

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

Resolves the specified alias and return the referenced deployable object part. It is tried to resolve the specified alias: Therefore, the list of deployable object parts of the current deployable object is scanned and the first matching alias within one of these parts is used for the resolution of the alias.

Parameters:

alias - the alias that should be resolved

Returns:

the deployable object part that is described by the alias

Throws:

WDAliasResolvingException - if the specified alias cannot be resolved

resolveAlias

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

Resolves the specified alias on the level of the deployable object part contained within the current deployable object and return the referenced deployable object part.

Parameters:

alias - the alias that should be resolved

part - the deployable object part that defines the alias which should be resolved

Returns:

the deployable object part that is described by the alias

Throws:

WDAliasResolvingException - if the specified alias to an deployable object within a certain deployable object cannot be resolved

getState

public WDDeployableObjectState getState()

Return is the state of the deployable object.

Returns:

the state of the deployable object

getSharingReferences

public java.lang.String[] getSharingReferences()
                                        throws WDSharingAccessException

Return the list of referenced deployable objects.

Returns:

an array containing the names of referenced deployable objects.

Throws:

WDSharingAccessException - if the sharing references of this deployable object cannot be determined

getReferencedDeployableObjects

public IWDDeployableObject[] getReferencedDeployableObjects()
                                                     throws WDSharingAccessException

Return the list of referenced deployable objects.

Returns:

an array containing the referenced deployable objects.

Throws:

WDSharingAccessException - if the referenced deployable objects of this deployable object cannot be determined

getServiceReferences

public java.lang.String[] getServiceReferences()
                                        throws WDSharingAccessException

Return the list of referenced services.

Returns:

an array containing the names of referenced services.

Throws:

WDSharingAccessException - if the service references of this deployable object cannot be determined

getLibrariesReferences

public java.lang.String[] getLibrariesReferences()
                                          throws WDSharingAccessException

Return the list of referenced libraries.

Returns:

an array containing the names of referenced libraries.

Throws:

WDSharingAccessException - if the library references of this deployable object cannot be determined

getInterfacesReferences

public java.lang.String[] getInterfacesReferences()
                                           throws WDSharingAccessException

Return the list of referenced interfaces.

Returns:

an array containing the names of referenced interfaces.

Throws:

WDSharingAccessException - if the interface references of this deployable object cannot be determined

isReferencedBy

public java.lang.String[] isReferencedBy()
                                  throws WDSharingAccessException

Return the list of deployable objects referencing the actual deployable object.

Returns:

an array containing the names of the deployable objects referencing the actual deployable object.

Throws:

WDSharingAccessException - if the deployable objects referencing this deployable object cannot be determined

isReferencedByObjects

public IWDDeployableObject[] isReferencedByObjects()
                                            throws WDSharingAccessException

Return the list of deployable objects referencing the actual deployable object.

Returns:

an array containing the deployable objects referencing the actual deployable object.

Throws:

WDSharingAccessException - if the deployable objects referencing this deployable object cannot be determined

getUsedJCOClients

public java.lang.String[] getUsedJCOClients()
                                     throws WDSharingAccessException

Return the list of used JCO clients defined in the actual deployable object.

Returns:

an array containing the names of the used referenced JCO clients.

Throws:

WDSharingAccessException - if the used JCO clients of this deployable object cannot be determined