Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatabaseDefDES

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKDatabaseDefDES
All Implemented Interfaces:
DKConstant, DKConstantDES, dkEntityDef, DKMessageId, java.io.Serializable

public class DKDatabaseDefDES
extends dkAbstractEntityDef
implements java.io.Serializable, DKConstantDES

DKDatabaseDefDES class defines methods to access DES entity information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDES
DK_DES_APPID_HANDLE, DK_DES_APPINFO_HANDLE, DK_DES_BROKER_HANDLE, DK_DES_CMBROOT, DK_DES_DATASOURCE, DK_DES_DLL_NAME, DK_DES_DSTYPE, DK_DES_GQL_QL_TYPE, DK_DES_INIFILE, DK_DES_ITEMID_SEPARATOR, DK_DES_PORT, DK_DES_PROPERTY_DISPNAME, DK_DES_PROPERTY_HELPTEXT, DK_DES_PROPERTY_LANGUAGE, DK_DES_PROPERTY_RETRIEVABLE, DK_DES_PROPERTY_SEARCHABLE, DK_DES_PROPERTY_SEARCHOPERATOR, DK_DES_PROPERTY_VALUECOUNT, DK_DES_REPOSITORIES_HANDLE, DK_DES_RMIREF_HANDLE, DK_DES_SESSION_HANDLE, DK_FILESYSTEM_ENTITY, DK_NOTES_ENTITY, DK_NOTESPUMP_ENTITY, DK_WEB_ENTITY
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatabaseDefDES()
          Default constructor with no parameter.
DKDatabaseDefDES(dkDatastore ds)
          Constructs a new DKDatabaseDefDES class with owner datastore object
 
Method Summary
 void add()
          Adds this entity definition to the persistent store, i.e.
 void add(dkAttrDef attrObj)
          Adds the given attribute definition object to the this entity in the persistent store.
 dkAttrDef createAttr()
          Creates new dkAttrDef and returns it to caller.
 void del()
          Deletes this entity from the persistent store, e.g.
 void del(dkAttrDef attrObj)
          Deletes the given attribute from this entity in the persistent store.
 dkAttrDef getAttr(java.lang.String attrName)
          Retrieves an attribute object from a given attribute name
 java.lang.String getDisplayName()
          Get the display name of the database.
 java.lang.String getHelpText()
          Get the help text
 java.lang.String getLanguage()
          Get the language.
 int getNumVals()
          Get the number of values
 int getSchema()
          Get the schema
 boolean isTextSearchable()
          Checks if this entity is text searchable.
 java.lang.String[] listAttrNames()
          Gets a list of attributes
 dkCollection listAttrs()
          Gets a list of attributes
 void setDisplayName(java.lang.String dispName)
          Set the display name of the database.
 void setHelpText(java.lang.String txt)
          Set the help text
 void setLanguage(java.lang.String lang)
          Set the language.
 void setNumValues(int num)
          Set the number of values
 void setSchema(int schema)
          Set the schema
 void setTextSearchable(boolean textSearchable)
          Sets this entity to be text searchable
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, addAttr, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatabaseDefDES

public DKDatabaseDefDES()
                 throws DKException,
                        java.lang.Exception
Default constructor with no parameter.

DKDatabaseDefDES

public DKDatabaseDefDES(dkDatastore ds)
                 throws DKException,
                        java.lang.Exception
Constructs a new DKDatabaseDefDES class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates new dkAttrDef and returns it to caller.
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
new dkAttrDef object.
Throws:
DKException - if this entity does not have attribute

getAttr

public dkAttrDef getAttr(java.lang.String attrName)
                  throws DKException,
                         java.lang.Exception
Retrieves an attribute object from a given attribute name
Overrides:
getAttr in class dkAbstractEntityDef
Parameters:
attrName - name of attribute to be retrieved
Returns:
an attribute object
Throws:
DKException - if the attribute name is not exist

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes
Overrides:
listAttrs in class dkAbstractEntityDef
Returns:
a dkCollection of dkAttrDef's
Throws:
DKException - if error occurs

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attributes
Overrides:
listAttrNames in class dkAbstractEntityDef
Returns:
an array of attribute names
Throws:
DKException - if error occurs

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this entity definition to the persistent store, i.e. make this entity persistent.
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - when the subclass does not implement this method

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this entity from the persistent store, e.g. drop table. The in-memory copy is not changed.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - when the subclass does not implement this method

add

public void add(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Adds the given attribute definition object to the this entity in the persistent store.
Overrides:
add in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be added to this entity object
Throws:
DKException - if there is error in datastore server

del

public void del(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Deletes the given attribute from this entity in the persistent store.
Overrides:
del in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be deleted from this entity object
Throws:
DKException - if the error occurs in datastore

getDisplayName

public java.lang.String getDisplayName()
Get the display name of the database.
Returns:
display name

setDisplayName

public void setDisplayName(java.lang.String dispName)
Set the display name of the database.
Parameters:
display - name

getLanguage

public java.lang.String getLanguage()
Get the language.
Returns:
language

setLanguage

public void setLanguage(java.lang.String lang)
Set the language.
Parameters:
language -  

getHelpText

public java.lang.String getHelpText()
Get the help text
Returns:
help text

setHelpText

public void setHelpText(java.lang.String txt)
Set the help text
Parameters:
help - text

getSchema

public int getSchema()
Get the schema
Returns:
schema

setSchema

public void setSchema(int schema)
Set the schema
Parameters:
schema -  

getNumVals

public int getNumVals()
Get the number of values
Returns:
number of values

setNumValues

public void setNumValues(int num)
Set the number of values
Parameters:
number - of values

isTextSearchable

public boolean isTextSearchable()
Checks if this entity is text searchable.
Overrides:
isTextSearchable in class dkAbstractEntityDef
Returns:
true if this entity is text searchable, false otherwise

setTextSearchable

public void setTextSearchable(boolean textSearchable)
                       throws DKException,
                              java.lang.Exception
Sets this entity to be text searchable
Overrides:
setTextSearchable in class dkAbstractEntityDef
Parameters:
textSearchable - is true if the entity is text searchable

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.