com.ibm.mm.sdk.common

Interface dkEntityDef

All Known Implementing Classes:

dkAbstractEntityDef, DKComponentTypeDefICM, DKComponentTypeViewDefICM, DKItemTypeDefICM, DKItemTypeViewDefICM

public interface dkEntityDef

Interface for defining entity metadata in CM8.

An entity definition describes the structure and characteristics of a CM8 entity type, including its name, description, type, parent entity, and searchability. Entity definitions are used to define document classes, folder classes, and other object types in the system.

Entity Types:

• Document entities - Define document classes
• Folder entities - Define folder classes
• Item entities - Define item types
• Component entities - Define component types

Inheritance: Entity definitions support inheritance through the parent entity relationship. Child entities inherit attributes and behavior from their parent entities.

Example usage:

 dkEntityDef entityDef = datastore.createEntityDef();
 entityDef.setName("Invoice");
 entityDef.setDescription("Invoice document type");
 entityDef.setType(DKConstant.DK_CM_DOCUMENT);
 entityDef.setParentEntityName("Document");
 entityDef.setSearchable(true);
 

See Also:

dkAttrDef, dkDatastore, DKConstant

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description of this entity definition.
java.lang.String	getName() Gets the name of this entity definition.
java.lang.String	getParentEntityName() Gets the parent entity name.
short	getType() Gets the type of this entity.
boolean	isSearchable() Checks if this entity is searchable.
void	setDescription(java.lang.String desc) Sets the description of this entity definition.
void	setName(java.lang.String name) Sets the name of this entity definition.
void	setParentEntityName(java.lang.String parentEntityName) Sets the parent entity name for inheritance.
void	setSearchable(boolean searchable) Sets whether this entity is searchable.
void	setType(short entityType) Sets the type of this entity.

Method Detail

setName

void setName(java.lang.String name)

Sets the name of this entity definition.

Parameters:

name - the entity name (e.g., "Invoice", "Contract")

getName

java.lang.String getName()

Gets the name of this entity definition.

Returns:

the entity name

setDescription

void setDescription(java.lang.String desc)

Sets the description of this entity definition.

Parameters:

desc - a human-readable description of the entity

getDescription

java.lang.String getDescription()

Gets the description of this entity definition.

Returns:

the entity description

setType

void setType(short entityType)

Sets the type of this entity.

Parameters:

entityType - the entity type constant (e.g., DKConstant.DK_CM_DOCUMENT)

See Also:

DKConstant

getType

short getType()

Gets the type of this entity.

Returns:

the entity type constant

See Also:

DKConstant

setParentEntityName

void setParentEntityName(java.lang.String parentEntityName)

Sets the parent entity name for inheritance.

Parameters:

parentEntityName - the name of the parent entity, or null if no parent

getParentEntityName

java.lang.String getParentEntityName()

Gets the parent entity name.

Returns:

the parent entity name, or null if no parent

setSearchable

void setSearchable(boolean searchable)

Sets whether this entity is searchable.

Parameters:

searchable - true if the entity should be searchable, false otherwise

isSearchable

boolean isSearchable()

Checks if this entity is searchable.

Returns:

true if the entity is searchable, false otherwise