Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKIndexClassDefV4

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

public class DKIndexClassDefV4
extends dkAbstractEntityDef
implements DKConstantV4, DKMessageIdV4, java.io.Serializable

This class defines methods to access entity information for an index class

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantV4
    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.DKMessageIdV4
copyright, DK_V4_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKIndexClassDefV4()
          Constructor
DKIndexClassDefV4(dkDatastore ds)
          Constructor
 
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 this entity in the persistent store.
 dkAttrDef createAttr()
          Creates a new dkAttrDef
 void del()
          Deletes this entity from the persistent store.
 void del(dkAttrDef attrObj)
          Deletes the given attribute from this entity in the persistent store.
 dkAttrDef getAttr(java.lang.String attrName)
          Retrieves an attribute definition object from a given attribute name
 java.lang.String[] listAttrNames()
          Gets a list of attribute names
 dkCollection listAttrs()
          Gets a list of attributes
 
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, isTextSearchable, listSubEntities, listSubEntityNames, 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

DKIndexClassDefV4

public DKIndexClassDefV4()
Constructor

DKIndexClassDefV4

public DKIndexClassDefV4(dkDatastore ds)
Constructor
Parameters:
ds - a datastore object
Method Detail

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates a new dkAttrDef
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
a new dkAttrDef object.
Throws:
DKException - if this entity does not have attribute
java.lang.Exception - if error detected

getAttr

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

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
java.lang.Exception - if error detected

listAttrNames

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

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 - if error detected
java.lang.Exception - if error detected

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this entity from the persistent store. The in-memory copy is not changed.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - if error detected
java.lang.Exception - if error detected

add

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

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 definition object to be deleted from this entity object
Throws:
DKException - if the error occurs in datastore

EIP Java APIs

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