com.sap.tc.complib
Interface Entity

All Superinterfaces:

Identifiable

public interface Entity

extends Identifiable

Interface representing an entity of a development component.

Method Summary

java.lang.String	getCaption() Returns a human readable name of the entity
java.lang.String	getDescription() Returns the description of the entity
FileSet	getFileSet()
java.lang.String	getName() Returns the name of the entity
java.lang.String	getPackageName() Returns the package to which this entity belongs.
java.lang.String	getSubType() Returns the subtype of the entity
java.lang.String	getType() Returns the type of the entity
void	serialize(XMLWriter writer) Serializes the reference to the given XMLWriter.
void	serialize(XMLWriter writer, java.lang.String formatVersion)
void	setCaption(java.lang.String caption) Sets a human readable name of the entity
void	setDescription(java.lang.String description) Sets the description of the entity
void	setFileSet(FileSet fileSet)
void	setName(java.lang.String name) Sets the name of the entity
void	setPackageName(java.lang.String packageName) Sets the package to which this entity should belong.
void	setSubType(java.lang.String subtype) Sets the subtype of the entity
void	setType(java.lang.String type) Sets the type of the entity
void	validate() Verifies that the enity is valid (according to the DTD).

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

getUniqueKey

Method Detail

getName

public java.lang.String getName()

Returns the name of the entity

setName

public void setName(java.lang.String name)

Sets the name of the entity

getCaption

public java.lang.String getCaption()

Returns a human readable name of the entity

setCaption

public void setCaption(java.lang.String caption)

Sets a human readable name of the entity

getDescription

public java.lang.String getDescription()

Returns the description of the entity

setDescription

public void setDescription(java.lang.String description)

Sets the description of the entity

getPackageName

public java.lang.String getPackageName()

Returns the package to which this entity belongs.

Returns:

the package name, or null if the entity does not belong to a package.

setPackageName

public void setPackageName(java.lang.String packageName)

Sets the package to which this entity should belong.

Parameters:

a - package name, or null if a previously set package name should be removed.

getType

public java.lang.String getType()

Returns the type of the entity

setType

public void setType(java.lang.String type)

Sets the type of the entity

getSubType

public java.lang.String getSubType()

Returns the subtype of the entity

setSubType

public void setSubType(java.lang.String subtype)

Sets the subtype of the entity

getFileSet

public FileSet getFileSet()

Returns:

Since:

SCHEMA_1_0_1

setFileSet

public void setFileSet(FileSet fileSet)

Parameters:

fileSet -

Since:

SCHEMA_1_0_1

validate

public void validate()
              throws ValidationException

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

Throws:

ValidationException - if the entity 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

Parameters:

writer -

formatVersion -

Throws:

ValidationException -