Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatabaseDefQBIC

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

public class DKDatabaseDefQBIC
extends dkAbstractEntityDef
implements DKConstantDL, DKMessageIdDL, java.io.Serializable

This class defines methods to access entity information for QBIC.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL
    For details, see the class or interface
 
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.DKMessageIdDL
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatabaseDefQBIC()
          Constructs a database def for QBIC
DKDatabaseDefQBIC(dkDatastore ds)
          Constructs a database def for QBIC
 
Method Summary
 void add()
          Adds this entity definition to the persistent store, i.e.
 void add(dkEntityDef subEntityObj)
          Adds the sub entity definition object to the this entity in the persistent store.
 DKCatalogDefQBIC createCatalog()
          Creates new catalog definition and returns it to caller.
 dkEntityDef createSubEntity()
          Creates new dkEntityDef and returns it to caller.
 void del()
          Deletes this entity from the persistent store, e.g.
 void del(dkEntityDef subEntityObj)
          Delete the sub entity definition object from this entity in the persistent store.
 DKCatalogDefQBIC getCatalog(java.lang.String catalogName)
          Retrieves a catalog object from a given catalog name.
 dkEntityDef getSubEntity(java.lang.String subEntityName)
          Retrieves a sub entity object from a given sub entity name.
 boolean hasSubEntities()
          Checks if this entity has sub entity objects
 boolean isSearchable()
          Checks if the entity is searchable
 java.lang.String[] listCatalogNames()
          Gets a list of catalog def names from persistent datastore
 dkCollection listCatalogs()
          Gets a list of catalog def from persistent datastore
 dkCollection listSubEntities()
          Gets a list of sub entities
 java.lang.String[] listSubEntityNames()
          Gets a list of sub entity names
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, addAttr, addSubEntity, clearCache, createAttr, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getAttr, getDatastore, getDescription, getName, getParentEntityName, getType, isTextSearchable, listAttrNames, listAttrs, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatabaseDefQBIC

public DKDatabaseDefQBIC()
Constructs a database def for QBIC

DKDatabaseDefQBIC

public DKDatabaseDefQBIC(dkDatastore ds)
Constructs a database def for QBIC
Parameters:
ds - datastore
Method Detail

hasSubEntities

public boolean hasSubEntities()
                       throws DKException,
                              java.lang.Exception
Checks if this entity has sub entity objects
Overrides:
hasSubEntities in class dkAbstractEntityDef
Returns:
true if has sub entities, false otherwise

createSubEntity

public dkEntityDef createSubEntity()
                            throws DKException,
                                   java.lang.Exception
Creates new dkEntityDef and returns it to caller.
Overrides:
createSubEntity in class dkAbstractEntityDef
Returns:
new dkEntityDef object.
Throws:
DKException - if the datastore does not support multi-level entity, i.e. this entity object does not have sub-entities.

getSubEntity

public dkEntityDef getSubEntity(java.lang.String subEntityName)
                         throws DKException,
                                java.lang.Exception
Retrieves a sub entity object from a given sub entity name. This method is provided to support multi-level document model.
Overrides:
getSubEntity in class dkAbstractEntityDef
Parameters:
subEntityName - name of attribute to be retrieved
Returns:
an (sub) entity object
Throws:
DKException - if the datastore does not support multi-level entity, i.e. this entity object does not have sub-entities.

listSubEntities

public dkCollection listSubEntities()
                             throws DKException,
                                    java.lang.Exception
Gets a list of sub entities
Overrides:
listSubEntities in class dkAbstractEntityDef
Returns:
a dkCollection of dkEntityDef's
Throws:
DKException - if the datastore does not support multi-level entity, i.e. this entity object does not have sub-entities.

listSubEntityNames

public java.lang.String[] listSubEntityNames()
                                      throws DKException,
                                             java.lang.Exception
Gets a list of sub entity names
Overrides:
listSubEntityNames in class dkAbstractEntityDef
Returns:
an array of entity names
Throws:
DKException - if the datastore does not support multi-level entity, i.e. this entity object does not have sub-entities.

createCatalog

public DKCatalogDefQBIC createCatalog()
                               throws DKException,
                                      java.lang.Exception
Creates new catalog definition and returns it to caller.
Returns:
new catalog definition object.

getCatalog

public DKCatalogDefQBIC getCatalog(java.lang.String catalogName)
                            throws DKException,
                                   java.lang.Exception
Retrieves a catalog object from a given catalog name. This method is provided to support multi-level document model.
Parameters:
catalogName - name of catalog to be retrieved
Returns:
an (sub) catalog object

listCatalogs

public dkCollection listCatalogs()
                          throws DKException,
                                 java.lang.Exception
Gets a list of catalog def from persistent datastore
Returns:
a collection of catalog defs
Throws:
DKException - if error occurs

listCatalogNames

public java.lang.String[] listCatalogNames()
                                    throws DKException,
                                           java.lang.Exception
Gets a list of catalog def names from persistent datastore
Returns:
an array of catalog names
Throws:
DKException - if error occurs

isSearchable

public boolean isSearchable()
                     throws DKException,
                            java.lang.Exception
Description copied from class: dkAbstractEntityDef
Checks if the entity is searchable
Overrides:
isSearchable in class dkAbstractEntityDef
Following copied from class: com.ibm.mm.sdk.common.dkAbstractEntityDef
Returns:
true if entity is searchable

add

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

del

public void del(dkEntityDef subEntityObj)
         throws DKException,
                java.lang.Exception
Delete the sub entity definition object from this entity in the persistent store.
Overrides:
del in class dkAbstractEntityDef
Parameters:
subEntityObj - an sub entity object to be deleted from this entity object
Throws:
DKException - if the error occurs in datastore

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

EIP Java APIs

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