Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKEntityInventoryDefFed

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

public class DKEntityInventoryDefFed
extends dkAbstractEntityDef
implements DKConstantFed, java.io.Serializable

This class implements the dkEntityDef interface to access the data in Server Inventory table. The extra data member ServerName needs to be set to complete the operation;

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    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.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKEntityInventoryDefFed()
          Default Constructor
DKEntityInventoryDefFed(dkDatastore ds)
          Constructs a new DKEntityInventoryDefFed class with owner datastore object
 
Method Summary
 void add()
          Adds this Inventory Entity to become a persistent part in the federated database
 void add(dkAttrDef attrObj)
          Add the Inventory Attribute to the Entity and put in the persistent database
 void addAttr(dkAttrDef attrObj)
          Add the Inventory Attribute to the Entity as in memory.
 java.lang.String datastoreName()
          Gets the name of the native server.
 void del()
          Removes this inventory entity and associated attributes from the persistent federated database
 void del(dkAttrDef attrObj)
          Removes this inventory attributes from the persistent federated database
 java.lang.String getServerName()
          Get the server name.
 java.lang.String[] listAttrNames()
          Gets a list of attributes
 dkCollection listAttrs()
          Gets a list of attributes
 void setServerName(java.lang.String name)
          Set the server name.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, addSubEntity, clearCache, createAttr, createSubEntity, datastoreType, del, deleteAttr, deleteSubEntity, getAttr, 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

DKEntityInventoryDefFed

public DKEntityInventoryDefFed()
Default Constructor

DKEntityInventoryDefFed

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

datastoreName

public java.lang.String datastoreName()
                               throws java.lang.Exception
Gets the name of the native server.
Overrides:
datastoreName in class dkAbstractEntityDef
Returns:
datastore name

add

public void add(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Add the Inventory Attribute to the Entity and put in the persistent database
Overrides:
add in class dkAbstractEntityDef
Parameters:
attrObj - an instance of DKAttrInventoryDefFed.java

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this Inventory Entity to become a persistent part in the federated database
Overrides:
add in class dkAbstractEntityDef
Following copied from class: com.ibm.mm.sdk.common.dkAbstractEntityDef
Throws:
DKException - when the subclass does not implement this method

addAttr

public void addAttr(dkAttrDef attrObj)
             throws DKException,
                    java.lang.Exception
Add the Inventory Attribute to the Entity as in memory. The add() function must be called to create the entity and attribute in the persistent database.
Overrides:
addAttr in class dkAbstractEntityDef
Parameters:
attrObj - an instance of DKAttrInventoryDefFed.java

del

public void del()
         throws DKException,
                java.lang.Exception
Removes this inventory entity and associated attributes from the persistent federated database
Overrides:
del in class dkAbstractEntityDef
Following copied from class: com.ibm.mm.sdk.common.dkAbstractEntityDef
Throws:
DKException - when the subclass does not implement this method

del

public void del(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Removes this inventory attributes from the persistent federated database
Overrides:
del in class dkAbstractEntityDef
Parameters:
attrObj - an instance of DKAttrInventoryDefFed.java

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes
Overrides:
listAttrs in class dkAbstractEntityDef
Returns:
a dkCollection of DKAttrInventoryDefFed

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

getServerName

public java.lang.String getServerName()
Get the server name.

setServerName

public void setServerName(java.lang.String name)
                   throws DKException,
                          java.lang.Exception
Set the server name.

EIP Java APIs

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