|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.FormatElement
com.ibm.btt.services.ldap.LDAPRequestFormat
public class LDAPRequestFormat
This class provides formatting support for the LDAP Access service. It is initialized from externalized data, and after initialization contains the data and definitions needed to create an LDAP request model object. The request model object is created, initialized, and returned when the doFormat(Context) method is called on this class. Note that unlike regular format objects, this class does not use the format(Context) method, and does not implement any functionality in the unformat(String, DataElement) method.
Field Summary | |
---|---|
protected static java.lang.String |
RST_ATTR_LIST
|
protected static java.lang.String |
RST_FILTER_LIST
|
protected static java.lang.String |
RST_LDAP_NAME
|
protected static java.lang.String |
RST_MOD_LIST
|
Fields inherited from class com.ibm.btt.base.FormatElement |
---|
dataElementName |
Constructor Summary | |
---|---|
LDAPRequestFormat()
LDAPRequestFormat constructor. |
Method Summary | |
---|---|
LDAPRequest |
doFormat(Context context)
The format() method defined in FormatElement does not support the functionality required of this particular format class. |
LDAPRequest |
doFormat(Operation operation)
Provides equivalent functionality as doFormat(operation.getContext()) |
java.lang.String |
format(DataElement data)
Format abstract class. |
java.lang.String |
getFilterType()
Returns the filter type (for search requests) defined for this format element. |
java.lang.String |
getName()
Returns the name of this format element. |
java.lang.String |
getRequestType()
Returns the request type defined for this format element. |
java.lang.Object |
getValue(Context context,
java.lang.String name,
boolean required)
Obtains a named value from the supplied context and returns it. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes this format with externalized data. |
void |
removeExternal()
Removes the XML tags used to externalize this object from the SGML file they are in. |
void |
setFilterType(java.lang.String newFilterType)
Sets the filter type (for search requests) for this format element. |
void |
setName(java.lang.String newName)
Sets the name of this format element. |
void |
setRequestType(java.lang.String type)
Sets the request type for this format element. |
void |
setValueAt(Context targetCtx,
Context sourceCtx,
java.lang.String dataName,
boolean required)
Transfers named value from the source context to the target context. |
java.lang.String |
toString()
Returns the string representation of this class. |
Vector |
toStrings()
Returns a vector containing the string representation of the XML tags used to externalize this object. |
DataElement |
unformat(java.lang.String str,
DataElement element)
Unformat abstract method. |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
checkIndexes, exceptionInfo, externalizer, extract, format, getDataElementName, getExternalizer, getTagName, isCacheable, isConstant, isItConstant, isNull, readExternal, readExternal, readObject, reinitialize, rootDecorated, setDataElementName, setExternalizer, setSize, toTags, unformat, unformat, unformat, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String RST_LDAP_NAME
protected static final java.lang.String RST_FILTER_LIST
protected static final java.lang.String RST_MOD_LIST
protected static final java.lang.String RST_ATTR_LIST
Constructor Detail |
---|
public LDAPRequestFormat()
Method Detail |
---|
public LDAPRequest doFormat(Context context) throws DSEException, DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
context
- com.ibm.btt.base.Context
DSEException
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public LDAPRequest doFormat(Operation operation) throws DSEException, DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
operation
- com.ibm.btt.base.Operation
DSEException
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String format(DataElement data)
FormatElement
format
in class FormatElement
data
- DataElement
public java.lang.String getFilterType()
public java.lang.String getName()
getName
in interface Cacheable
getName
in class FormatElement
public java.lang.String getRequestType()
public java.lang.Object getValue(Context context, java.lang.String name, boolean required) throws DSEException
context
- com.ibm.btt.base.Contextname
- java.lang.Stringrequired
- boolean
DSEException
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
initializeFrom
in class FormatElement
aTag
- com.ibm.btt.base.Tag
java.io.IOException
DSEException
public void removeExternal() throws java.io.IOException
removeExternal
in class FormatElement
java.io.IOException
public void setFilterType(java.lang.String newFilterType)
newFilterType
- java.lang.Stringpublic void setName(java.lang.String newName)
setName
in class FormatElement
newName
- java.lang.Stringpublic void setRequestType(java.lang.String type)
str
- java.lang.Stringpublic void setValueAt(Context targetCtx, Context sourceCtx, java.lang.String dataName, boolean required) throws DSEException
targetCtx
- com.ibm.btt.base.ContextsourceCtx
- com.ibm.btt.base.ContextdataName
- java.lang.Stringrequired
- boolean
DSEException
public java.lang.String toString()
toString
in class FormatElement
public Vector toStrings()
toStrings
in class FormatElement
public DataElement unformat(java.lang.String str, DataElement element)
FormatElement
unformat
in class FormatElement
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |