Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKPredefinedValues

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKPredefinedValues
All Implemented Interfaces:
DKConstant, java.io.Serializable

public class DKPredefinedValues
extends java.lang.Object
implements java.io.Serializable, DKConstant

DKPredefinedValues is a class to hold all the mapping value pairs of a search field. Each value pair is represented as a DKNVPair that the Federated Attribute Value is stored as DKNVPair.name and the Native Attribute Value is stored as DKNVPair.value.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKPredefinedValues()
          Default constructor with no parameter.
DKPredefinedValues(java.lang.String entName, java.lang.String attrName)
          Constructor with native entity name & native attribute name as parameters.
DKPredefinedValues(java.lang.String entName, java.lang.String attrName, java.lang.String serverName)
          Constructor with native entity name, native attribute name & server name as parameters.
 
Method Summary
 void addValuePair(java.lang.String fedAttrValue, java.lang.String nativeAttrValue)
          Adds the mapping Federated Attribute Value/Native Attribute Value pair to the memory.
 java.lang.String getAttrName()
          Gets the native attribute name
 java.lang.String getEntityName()
          Gets the native entity name
 int getServerId()
          Gets the server id that contain the entity/attribute pair of this object
 java.lang.String getServerName()
          Gets the server name that contain the entity/attribute pair of this object
 dkCollection getValuePairs()
          Gets the list of mapping Federated Attribute Value/Native Attribute Value pairs
 void removeValuePair(java.lang.String fedAttrValue, java.lang.String nativeAttrValue)
          Remove the mapping Federated Attribute Value/Native Attribute Value pair from the memory.
 void setAttrName(java.lang.String attrName)
          Sets the native attribute name
 void setEntityName(java.lang.String entName)
          Sets the native entity name
 void setServerId(int serverId)
          Sets the server id that contain the entity/attribute pair of this object
 void setServerName(java.lang.String serverName)
          Sets the server name that contain the entity/attribute pair of this object
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKPredefinedValues

public DKPredefinedValues()
Default constructor with no parameter.

DKPredefinedValues

public DKPredefinedValues(java.lang.String entName,
                          java.lang.String attrName)
Constructor with native entity name & native attribute name as parameters.
Parameters:
entName - native entity name
attrName - native attribute name

DKPredefinedValues

public DKPredefinedValues(java.lang.String entName,
                          java.lang.String attrName,
                          java.lang.String serverName)
Constructor with native entity name, native attribute name & server name as parameters.
Parameters:
entName - native entity name
attrName - native attribute name
serverName - the server containing above entity/attribute pair
Method Detail

getEntityName

public java.lang.String getEntityName()
Gets the native entity name
Returns:
the native entity name

setEntityName

public void setEntityName(java.lang.String entName)
Sets the native entity name
Parameters:
name - a native entity name to be set to this object

getAttrName

public java.lang.String getAttrName()
Gets the native attribute name
Returns:
the native attribute name

setAttrName

public void setAttrName(java.lang.String attrName)
Sets the native attribute name
Parameters:
name - a native attribute name to be set to this object

getServerId

public int getServerId()
Gets the server id that contain the entity/attribute pair of this object
Returns:
the server id

setServerId

public void setServerId(int serverId)
Sets the server id that contain the entity/attribute pair of this object
Parameters:
serverId - a server id

getServerName

public java.lang.String getServerName()
Gets the server name that contain the entity/attribute pair of this object
Returns:
the server name

setServerName

public void setServerName(java.lang.String serverName)
Sets the server name that contain the entity/attribute pair of this object
Parameters:
serverName - a server name

addValuePair

public void addValuePair(java.lang.String fedAttrValue,
                         java.lang.String nativeAttrValue)
Adds the mapping Federated Attribute Value/Native Attribute Value pair to the memory.
Parameters:
fedAttrValue - a Federated Attribute Value
nativeAttrValue - a Native Attribute Value

removeValuePair

public void removeValuePair(java.lang.String fedAttrValue,
                            java.lang.String nativeAttrValue)
Remove the mapping Federated Attribute Value/Native Attribute Value pair from the memory.
Parameters:
fedAttrValue - a Federated Attribute Value
nativeAttrValue - a Native Attribute Value

getValuePairs

public dkCollection getValuePairs()
                           throws DKException,
                                  java.lang.Exception
Gets the list of mapping Federated Attribute Value/Native Attribute Value pairs
Returns:
a Vector of DKNVPair; the getName() to get the Fed. Attr. value and the getValue() to get the native attr. value.

EIP Java APIs

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