com.ibm.mm.sdk.common

Class dkAbstractEntityDef

  • java.lang.Object
    • com.ibm.mm.sdk.common.dkAbstractEntityDef
  • All Implemented Interfaces:
    dkEntityDef, java.io.Serializable
    Direct Known Subclasses:
    DKComponentTypeDefICM, DKComponentTypeViewDefICM

    public class dkAbstractEntityDef
extends java.lang.Object
implements dkEntityDef, java.io.Serializable
    Abstract base implementation of the dkEntityDef interface.

    This class provides a concrete implementation of entity definition functionality, storing entity metadata such as name, description, type, parent entity, and searchability. It serves as a base class for specific entity definition implementations.

    Key Features:

    • Serializable for distributed operations
    • Complete implementation of dkEntityDef interface
    • Support for entity inheritance through parent entity
    • Searchability configuration

    Example usage:

     dkAbstractEntityDef entityDef = new ConcreteEntityDef();
 entityDef.setName("Invoice");
 entityDef.setType(DKConstant.DK_CM_DOCUMENT);
 entityDef.setParentEntityName("Document");
 entityDef.setSearchable(true);
    See Also:
    dkEntityDef, DKConstant, Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • name

        protected java.lang.String name

      • description

        protected java.lang.String description

      • entityType

        protected short entityType

      • parentEntityName

        protected java.lang.String parentEntityName

      • searchable

        protected boolean searchable

    • Constructor Detail

      • dkAbstractEntityDef

        public dkAbstractEntityDef()

    • Method Detail

      • setName

        public void setName(java.lang.String name)
        Sets the name of this entity definition.
        Specified by:
        setName in interface dkEntityDef
        Parameters:
        name - the entity name (e.g., "Invoice", "Contract")

      • getName

        public java.lang.String getName()
        Gets the name of this entity definition.
        Specified by:
        getName in interface dkEntityDef
        Returns:
        the entity name

      • setDescription

        public void setDescription(java.lang.String desc)
        Sets the description of this entity definition.
        Specified by:
        setDescription in interface dkEntityDef
        Parameters:
        desc - a human-readable description of the entity

      • getDescription

        public java.lang.String getDescription()
        Gets the description of this entity definition.
        Specified by:
        getDescription in interface dkEntityDef
        Returns:
        the entity description

      • setType

        public void setType(short entityType)
        Sets the type of this entity.
        Specified by:
        setType in interface dkEntityDef
        Parameters:
        entityType - the entity type constant (e.g., DKConstant.DK_CM_DOCUMENT)
        See Also:
        DKConstant

      • getType

        public short getType()
        Gets the type of this entity.
        Specified by:
        getType in interface dkEntityDef
        Returns:
        the entity type constant
        See Also:
        DKConstant

      • setParentEntityName

        public void setParentEntityName(java.lang.String parentEntityName)
        Sets the parent entity name for inheritance.
        Specified by:
        setParentEntityName in interface dkEntityDef
        Parameters:
        parentEntityName - the name of the parent entity, or null if no parent

      • getParentEntityName

        public java.lang.String getParentEntityName()
        Gets the parent entity name.
        Specified by:
        getParentEntityName in interface dkEntityDef
        Returns:
        the parent entity name, or null if no parent

      • setSearchable

        public void setSearchable(boolean searchable)
        Sets whether this entity is searchable.
        Specified by:
        setSearchable in interface dkEntityDef
        Parameters:
        searchable - true if the entity should be searchable, false otherwise

      • isSearchable

        public boolean isSearchable()
        Checks if this entity is searchable.
        Specified by:
        isSearchable in interface dkEntityDef
        Returns:
        true if the entity is searchable, false otherwise
Skip navigation links
Copyright © 2024 IBM Corporation

Copyright © 2024 IBM Corporation. All rights reserved.