Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAttrInventoryDefFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAttrDef
        |
        +--com.ibm.mm.sdk.common.DKAttrInventoryDefFed
All Implemented Interfaces:
dkAttrDef, DKConstant, DKConstantFed, DKMessageId, java.io.Serializable

public class DKAttrInventoryDefFed
extends dkAbstractAttrDef
implements DKConstantFed, java.io.Serializable

This class implements the dkAttrDef interface to access the data in Server Inventory table. The extra data member ServerName and EntityName 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
DKAttrInventoryDefFed()
          Default Constructor
DKAttrInventoryDefFed(dkDatastore ds)
          Constructs a new DKAttrInventoryDefFed class with owner datastore object
 
Method Summary
 void add()
          Adds this Inventory attribute to become a persistent part in the federated database
 java.lang.String datastoreName()
          Gets the name of the native server.
 void del()
          Removes this inventory attribute from the persistent federated database
 short getControl()
          Get control
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 dkEntityDef getEntity()
          Gets the entity definition object that this attribute is belong to
 java.lang.String getServerName()
          Get the server name.
 short getStatus()
          Get status
 void setControl(short control)
          Set control
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setEntity(dkEntityDef entityObj)
          Sets the entity meta data object for this attribute
 void setEntityTextSearchable(boolean textsearchable)
          //sshi f32939 Sets text search ablility the entity this attr belong to
 void setNullable(boolean nullable)
          Sets whether null value is allowed for this attribute.
 void setQueryable(boolean queryable)
          Sets the queryability of this attribute.
 void setServerName(java.lang.String name)
          Set the server name.
 void setStatus(short status)
          Set status
 void setTextSearchable(boolean textsearchable)
          Sets text search ablility this attribute.
 void setUpdatable(boolean updatable)
          Sets the updatability of this attribute.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAttrDef
datastoreType, getDescription, getEntityName, getMax, getMin, getName, getPrecision, getQualifiedName, getScale, getSize, getStringType, getType, isNullable, isQueryable, isTextSearchable, isUpdatable, parsedQualifiedName, setDescription, setEntityName, setMax, setMin, setName, setPrecision, setQualifiedName, setScale, setSize, setStringType, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAttrInventoryDefFed

public DKAttrInventoryDefFed()
Default Constructor

DKAttrInventoryDefFed

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

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Overrides:
setDatastore in class dkAbstractAttrDef
Following copied from interface: com.ibm.mm.sdk.common.dkAttrDef
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Overrides:
getDatastore in class dkAbstractAttrDef
Returns:
the dkDatastore object

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this Inventory attribute to become a persistent part in the federated database
Overrides:
add in class dkAbstractAttrDef

del

public void del()
         throws DKException,
                java.lang.Exception
Removes this inventory attribute from the persistent federated database
Overrides:
del in class dkAbstractAttrDef

getEntity

public dkEntityDef getEntity()
Gets the entity definition object that this attribute is belong to
Overrides:
getEntity in class dkAbstractAttrDef
Returns:
a DKEntityInventoryDefFed object contain meta data for the entity

setEntity

public void setEntity(dkEntityDef entityObj)
Sets the entity meta data object for this attribute
Overrides:
setEntity in class dkAbstractAttrDef
Parameters:
entityObj - dkEntityDef object

datastoreName

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

getControl

public short getControl()
Get control

setControl

public void setControl(short control)
Set control

setQueryable

public void setQueryable(boolean queryable)
Sets the queryability of this attribute.
Overrides:
setQueryable in class dkAbstractAttrDef
Parameters:
queryable - true if queryable value, false otherwise

setUpdatable

public void setUpdatable(boolean updatable)
Sets the updatability of this attribute.
Overrides:
setUpdatable in class dkAbstractAttrDef
Parameters:
updatable - true if updatable value, false otherwise

setNullable

public void setNullable(boolean nullable)
Sets whether null value is allowed for this attribute.
Overrides:
setNullable in class dkAbstractAttrDef
Parameters:
nullable - true if null value is allowed, false otherwise

setTextSearchable

public void setTextSearchable(boolean textsearchable)
Sets text search ablility this attribute. sshi 08-15-01 f27248
Overrides:
setTextSearchable in class dkAbstractAttrDef
Parameters:
textsearchable - true if text search is allowed, false otherwise

setEntityTextSearchable

public void setEntityTextSearchable(boolean textsearchable)
//sshi f32939 Sets text search ablility the entity this attr belong to
Parameters:
textsearchable - true if text search is allowed, false otherwise

getStatus

public short getStatus()
Get status

setStatus

public void setStatus(short status)
Set status

getServerName

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

setServerName

public void setServerName(java.lang.String name)
Set the server name.

EIP Java APIs

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