Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractAttrGroupDef

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAttrGroupDef
All Implemented Interfaces:
dkAttrGroupDef, DKMessageId, java.io.Serializable
Direct Known Subclasses:
DKAttrGroupDefICM

public abstract class dkAbstractAttrGroupDef
extends java.lang.Object
implements dkAttrGroupDef, DKMessageId, java.io.Serializable

This class defines methods to access attribute group def information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractAttrGroupDef()
          Constructs a new dkAbstractAttrGroupDef class without owner datastore object.
dkAbstractAttrGroupDef(dkDatastore ds)
          Constructs a new dkAbstractAttrGroupDef class with owner datastore object
 
Method Summary
 void addAttr(dkAttrDef attrObj)
          Adds the given attribute to the group (memory-only)
 void clearCache()
          Clear datastore cache
 java.lang.String datastoreType()
          Gets the type for this datastore object
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getName()
          Gets attribute group name
 java.lang.String[] listAttrNames()
          Gets a list of attribute names defined to the attribute group
 dkCollection listAttrs()
          Gets a list of attributes defined to the attribute group
 void removeAttr(java.lang.String attrName)
          Removes the given attribute from the group (memory-only)
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setName(java.lang.String name)
          Sets attribute group name
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractAttrGroupDef

public dkAbstractAttrGroupDef()
Constructs a new dkAbstractAttrGroupDef class without owner datastore object.

dkAbstractAttrGroupDef

public dkAbstractAttrGroupDef(dkDatastore ds)
Constructs a new dkAbstractAttrGroupDef 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
Specified by:
setDatastore in interface dkAttrGroupDef
Following copied from interface: com.ibm.mm.sdk.common.dkAttrGroupDef
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkAttrGroupDef
Returns:
the dkDatastore object

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the type for this datastore object
Specified by:
datastoreType in interface dkAttrGroupDef
Returns:
datastore type
Throws:
DKException - if error occurs

getName

public java.lang.String getName()
Gets attribute group name
Specified by:
getName in interface dkAttrGroupDef
Returns:
name of this attribute group

setName

public void setName(java.lang.String name)
Sets attribute group name
Specified by:
setName in interface dkAttrGroupDef
Parameters:
name - new name to be set to this attribute group object

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes defined to the attribute group

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listAttrs in interface dkAttrGroupDef
Returns:
a dkCollection of dkAttrDef objects

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attribute names defined to the attribute group

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listAttrNames in interface dkAttrGroupDef
Returns:
an array of attribute names

addAttr

public void addAttr(dkAttrDef attrObj)
             throws DKException,
                    java.lang.Exception
Adds the given attribute to the group (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addAttr in interface dkAttrGroupDef
Parameters:
attrObj - attribute object to be added.

removeAttr

public void removeAttr(java.lang.String attrName)
                throws DKException,
                       java.lang.Exception
Removes the given attribute from the group (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeAttr in interface dkAttrGroupDef
Parameters:
attrObj - the attribute to be removed.

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkAttrGroupDef

EIP Java APIs

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