com.ibm.dse.services.ldap.model
Class LDAPModifyRequest

java.lang.Object
  |
  +--com.ibm.dse.services.ldap.model.LDAPRequest
        |
        +--com.ibm.dse.services.ldap.model.LDAPModifyRequest

public class LDAPModifyRequest
extends LDAPRequest

This class supports the modify request to the LDAP Composer service.


Fields inherited from class com.ibm.dse.services.ldap.model.LDAPRequest
COMPID, requestType
 
Constructor Summary
LDAPModifyRequest()
          LDAPModifyRequest constructor.
 
Method Summary
 void addAttributeToModify(java.lang.String key, java.lang.Object value, int modcode)
          This method is functionaly equivalent to addModificationItem(ModificationItem), with the arguments supplied to this method being used to construct the necessary ModificationItem.
 void addModificationItem(javax.naming.directory.ModificationItem item)
          A utility method used to manage the modification items used in carrying out this request.
 javax.naming.directory.ModificationItem[] getModificationItems()
          Returns the modification items used to carry out this modify request.
 void mapFromContext(Context context)
          This method supports externalization of an LDAP modify request.
 void removeModificationItem(javax.naming.directory.ModificationItem item)
          A utility method used to manage the modification items used in carrying out this request.
 void setModificationItems(javax.naming.directory.ModificationItem[] newModList)
          Sets the array of modification items used to carry out this modify request.
 
Methods inherited from class com.ibm.dse.services.ldap.model.LDAPRequest
getBooleanValue, getIntValue, getName, getRequestType, getValue, setName, setRequestType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LDAPModifyRequest

public LDAPModifyRequest()
LDAPModifyRequest constructor.
Method Detail

addAttributeToModify

public void addAttributeToModify(java.lang.String key,
                                 java.lang.Object value,
                                 int modcode)
This method is functionaly equivalent to addModificationItem(ModificationItem), with the arguments supplied to this method being used to construct the necessary ModificationItem.
Parameters:
key - java.lang.String
value - java.lang.Object
modcode - int

addModificationItem

public void addModificationItem(javax.naming.directory.ModificationItem item)
A utility method used to manage the modification items used in carrying out this request. This method adds an object to the collection.
Parameters:
item - javax.naming.directory.ModificationItem

getModificationItems

public javax.naming.directory.ModificationItem[] getModificationItems()
Returns the modification items used to carry out this modify request.
Returns:
javax.naming.directory.ModificationItem

mapFromContext

public void mapFromContext(Context context)
                    throws DSEException
This method supports externalization of an LDAP modify request. It maps external data definitions from a Composer context into the request model.
Overrides:
mapFromContext in class LDAPRequest
Parameters:
context - com.ibm.dse.base.Context
Throws:
DSEException -  

removeModificationItem

public void removeModificationItem(javax.naming.directory.ModificationItem item)
A utility method used to manage the modification items used in carrying out this request. This method removes an object from the collection.
Parameters:
item - javax.naming.directory.ModificationItem

setModificationItems

public void setModificationItems(javax.naming.directory.ModificationItem[] newModList)
Sets the array of modification items used to carry out this modify request. See JDK 1.3 documentation on javax.naming.directory.DirContext for more details.
Parameters:
newModList - javax.naming.directory.ModificationItem