Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkAttrGroupDef

All Known Implementing Classes:
dkAbstractAttrGroupDef

public interface dkAttrGroupDef

dkAttrGroupDef : This class represents a attribute group definition.


Method Summary
 void addAttr(dkAttrDef attrObj)
          Adds the given attribute to the group (memory-only)
 void clearCache()
          Clear attribute group cache
 java.lang.String datastoreType()
          Gets datastore type
 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
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

getName

public java.lang.String getName()
Gets attribute group name
Returns:
name of this attribute group

setName

public void setName(java.lang.String name)
Sets attribute group name
Parameters:
name - attribute group name

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets datastore type
Returns:
name of type of datastore this attribute group belongs to

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

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

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

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

Parameters:
attrObj - the attribute to be removed.

clearCache

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

Note:DKUsageError exception thrown if method is not implemented


EIP Java APIs

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