com.sap.tc.complib
Interface Dependency

All Superinterfaces:

Identifiable

public interface Dependency

extends Identifiable

Interface representing dependencies between development components, or development component and public parts.

Method Summary

boolean	equals(Dependency dep) Determines whether this instance is equal to the one passed as parameter.
java.lang.String	getBuildTimeQualifier()
DCReference	getComponent() Returns the development or software component to which this dependency points.
java.lang.String	getDeployTimeQualifier()
java.lang.String	getDesignTimeQualifier()
java.lang.String	getPublicPart() Returns the public part to which this dependency points (if any).
PPReference	getPublicPartDependency() Returns this dependency as reference to a public part.
java.lang.String	getRuntimeQuialifier() Returs the qualifier of the runtime dependency, for example "weak" or "strong".
boolean	isAtBuildTime() Checks whether this dependency is relevant for the component build process.
boolean	isAtDeployTime() Checks whether this dependency is relevant for deployment.
boolean	isAtDesignTime() Checks whether this dependency is relevant on the level of development entities.
boolean	isAtRunTime() Checks whether this dependency is relevant for the runtime system.
boolean	isForChildrenOnly() Returns whether the purpose of this dependency is to allow inner components to define own dependencies.
void	serialize(XMLWriter writer) Serializes the reference to the given XMLWriter.
void	serialize(XMLWriter writer, java.lang.String formatVersion)
void	setAtBuildTime(boolean atBuildTime) Sets whether this dependency is relevant for the component build process.
void	setAtBuildTime(boolean atBuildTime, java.lang.String qualifier)
void	setAtDeployTime(boolean atDeployTime) Sets whether this dependency is relevant for deployment.
void	setAtDeployTime(boolean atDeployTime, java.lang.String qualifier)
void	setAtDesignTime(boolean atDesignTime) Sets whether this dependency is valid is relevant on the level of development entities.
void	setAtDesignTime(boolean atDesignTime, java.lang.String qualifier)
void	setAtRunTime(boolean atRunTime) Sets whether this dependency is relevant for the runtime system.
void	setAtRunTime(boolean atRuntime, java.lang.String qualifier) Sets whether this dependency is relevant for the runtime system.
void	setBuildTimeQualifier(java.lang.String qualifier)
void	setComponent(DCReference component) Declares the development or software component to which this dependency points.
void	setDeployTimeQualifier(java.lang.String qualifier)
void	setDesignTimeQualifier(java.lang.String qualifier)
void	setForChildrenOnly(boolean forChildrenOnly) Sets whether the purpose of this dependency is to allow inner components to define own dependencies.
void	setPublicPart(java.lang.String publicPart) Sets the public part to which this dependency points (if any).
void	setPublicPartDependency(PPReference ref) Sets this dependency from the given reference to a public part.
void	setRuntimeQualifier(java.lang.String qualifier) Sets the qualifier of the runtime dependency
void	validate() Verifies that the depedency is valid (according to the DTD).

Methods inherited from interface com.sap.tc.complib.Identifiable

getUniqueKey

Method Detail

getComponent

public DCReference getComponent()

Returns the development or software component to which this dependency points.

Returns:

reference to a component.

setComponent

public void setComponent(DCReference component)

Declares the development or software component to which this dependency points.

Parameters:

reference - to a component.

getPublicPart

public java.lang.String getPublicPart()

Returns the public part to which this dependency points (if any).

setPublicPart

public void setPublicPart(java.lang.String publicPart)

Sets the public part to which this dependency points (if any).

getPublicPartDependency

public PPReference getPublicPartDependency()

Returns this dependency as reference to a public part.

setPublicPartDependency

public void setPublicPartDependency(PPReference ref)

Sets this dependency from the given reference to a public part.

isForChildrenOnly

public boolean isForChildrenOnly()

Returns whether the purpose of this dependency is to allow inner components to define own dependencies.

Returns:

true, if inner components are allowed to declare own dependencies.

setForChildrenOnly

public void setForChildrenOnly(boolean forChildrenOnly)

Sets whether the purpose of this dependency is to allow inner components to define own dependencies.

Parameters:

if - true, inner components are allowed to declare own dependencies.

isAtDesignTime

public boolean isAtDesignTime()

Checks whether this dependency is relevant on the level of development entities.

Returns:

true, if the dependency is relevant at design time.

setAtDesignTime

public void setAtDesignTime(boolean atDesignTime)

Sets whether this dependency is valid is relevant on the level of development entities.

Parameters:

true, - if the dependency should be relevant at design time.

setAtDesignTime

public void setAtDesignTime(boolean atDesignTime,
                            java.lang.String qualifier)

Parameters:

atDesignTime -

qualifier -

Since:

API 1.0.2

setDesignTimeQualifier

public void setDesignTimeQualifier(java.lang.String qualifier)

Parameters:

qualifier -

Since:

API 1.0.2

getDesignTimeQualifier

public java.lang.String getDesignTimeQualifier()

Returns:

Since:

API 1.0.2

isAtBuildTime

public boolean isAtBuildTime()

Checks whether this dependency is relevant for the component build process.

Returns:

true, if the dependency is relevant for the component build process.

setAtBuildTime

public void setAtBuildTime(boolean atBuildTime)

Sets whether this dependency is relevant for the component build process.

Parameters:

true, - if the dependency should be relevant for the component build process.

setAtBuildTime

public void setAtBuildTime(boolean atBuildTime,
                           java.lang.String qualifier)

Parameters:

atBuildTime -

qualifier -

Since:

API 1.0.2

setBuildTimeQualifier

public void setBuildTimeQualifier(java.lang.String qualifier)

Parameters:

qualifier -

Since:

API 1.0.2

getBuildTimeQualifier

public java.lang.String getBuildTimeQualifier()

Returns:

Since:

API 1.0.2

isAtDeployTime

public boolean isAtDeployTime()

Checks whether this dependency is relevant for deployment. This means, a dependency of this type between two development components must be satisfied during deployment.

Returns:

true, if the dependency is relevant for deployment.

setAtDeployTime

public void setAtDeployTime(boolean atDeployTime)

Sets whether this dependency is relevant for deployment.

Parameters:

true, - if the dependency should be relevant for deployment.

setAtDeployTime

public void setAtDeployTime(boolean atDeployTime,
                            java.lang.String qualifier)

Parameters:

atDeployTime -

qualifier -

Since:

API 1.0.2

getDeployTimeQualifier

public java.lang.String getDeployTimeQualifier()

Returns:

Since:

API 1.0.2

setDeployTimeQualifier

public void setDeployTimeQualifier(java.lang.String qualifier)

Parameters:

qualifier -

Since:

API 1.0.2

isAtRunTime

public boolean isAtRunTime()

Checks whether this dependency is relevant for the runtime system.

Returns:

true, if the dependency is relevant for the runtime system.

setAtRunTime

public void setAtRunTime(boolean atRunTime)

Sets whether this dependency is relevant for the runtime system.

Parameters:

true, - if the dependency should be relevant for the runtime system.

setAtRunTime

public void setAtRunTime(boolean atRuntime,
                         java.lang.String qualifier)

Sets whether this dependency is relevant for the runtime system.

Parameters:

true, - if the dependency should be relevant for the runtime system.

qualifier - an optional attribute that allows to specify the quality or kind of this dependency in the runtime system.

getRuntimeQuialifier

public java.lang.String getRuntimeQuialifier()

Returs the qualifier of the runtime dependency, for example "weak" or "strong". The allowed values depend on the concrete DC type.

Returns:

an identifier that describes the quality or kind of this dependency in the runtime system

setRuntimeQualifier

public void setRuntimeQualifier(java.lang.String qualifier)

Sets the qualifier of the runtime dependency

Parameters:

qualifier - an identifier that describes the quality or kind of this dependency in the runtime system

validate

public void validate()
              throws ValidationException

Verifies that the depedency is valid (according to the DTD).

Throws:

ValidationException - if the object is not valid.

serialize

public void serialize(XMLWriter writer)
               throws ValidationException

Serializes the reference to the given XMLWriter.

Parameters:

writer - the XMLWriter to use for serialization.

serialize

public void serialize(XMLWriter writer,
                      java.lang.String formatVersion)
               throws ValidationException

equals

public boolean equals(Dependency dep)

Determines whether this instance is equal to the one passed as parameter. Implementations must overwrite equals(Object obj) to make sure semantics are the same.

Parameters:

dep - the Dependency that is tested to be equal with this one

Returns:

true if all properties of the dependencies are equal