|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyDescription
This interface is implemented by all PropertyDescriptors that descend from the abstract implementation, AbstractPropertyDescriptor. PropertyDescriptors are responsible for describing the business object with which they are associated. Each Type has an associated PropertyDescriptor to describe the Type's default business behavior.
Method Summary | |
---|---|
void |
applyDefaultDescriptor(PropertyDescription descriptor)
Forces this PropertyDescriptor to inherit the business rules of the passed descriptor. |
java.lang.Object |
cloneDescriptee(java.lang.Object value)
Returns an independent copy of the passed Object. |
java.lang.Object |
convertFrom(java.lang.Object obj)
Converts an input object into a proper object handled by the default converter. |
java.lang.Object |
convertFrom(java.lang.Object obj,
java.lang.String convType)
Converts an input object into a proper object handled by the specified converter. |
java.lang.Object |
convertFrom(java.lang.Object obj,
java.lang.String convType,
boolean byReference)
Converts an input object into a proper object handled by the specified converter. |
java.lang.Object |
convertFrom(java.lang.Object obj,
java.lang.String convType,
boolean byReference,
java.util.Locale locale)
Converts an input object into a proper object handled by the specified converter. |
java.lang.Object |
convertFrom(java.lang.Object obj,
java.lang.String convType,
boolean byReference,
java.util.Locale locale,
Hashtable parameters)
Converts an input object into a proper object handled by the specified converter. |
java.lang.Object |
convertTo(java.lang.Object obj)
Converts an input object, using the default converter, into a proper object handled by the invoker. |
java.lang.Object |
convertTo(java.lang.Object obj,
java.lang.String convType)
Converts an input object, using the specified converter, into a proper object handled by the invoker. |
java.lang.Object |
convertTo(java.lang.Object obj,
java.lang.String convType,
boolean byReference)
/** Converts an input object, using the specified converter, into a proper object handled by the invoker. |
java.lang.Object |
convertTo(java.lang.Object obj,
java.lang.String convType,
boolean byReference,
java.util.Locale locale)
Converts an input object, using the specified converter, into a proper object handled by the invoker. |
java.lang.Object |
convertTo(java.lang.Object obj,
java.lang.String convType,
boolean byReference,
java.util.Locale locale,
Hashtable parameters)
Converts an input object, using the specified converter, into a proper object handled by the invoker. |
java.lang.String |
formatToString(java.lang.Object value,
java.lang.String conversionType)
Returns the Object formatted as a String using the specified conversion type. |
java.lang.String |
formatToString(java.lang.Object value,
java.lang.String conversionType,
Hashtable parameters)
Returns the Object formatted as a String using the specified conversion type. |
java.lang.String |
formatToString(java.lang.Object value,
java.lang.String conversionType,
java.util.Locale locale)
Returns the Object formatted as a String using the specified conversion type and locale. |
void |
formatToWriter(java.lang.Object value,
java.lang.String conversionType,
java.io.Writer writer)
Formats the Object using the specified conversion type and writer passed as arguments. |
void |
formatToWriter(java.lang.Object value,
java.lang.String conversionType,
java.io.Writer writer,
java.util.Locale locale)
Formats the Object using the specified conversion type, writer, and locale passed as arguments. |
Conversion |
getConversion(java.lang.String conversionType)
Returns the converter that handles the specified conversion type or null if the conversion type is not supported. |
java.util.Enumeration |
getConverters()
Returns an Enumeration of all converters associated with this PropertyDescriptor. |
java.lang.String |
getDescription()
Returns the description of business object that this PropertyDescriptor describes. |
java.lang.Class |
getImplClass()
Gets the class of the business object described by this PropertyDescription. |
ElementState |
getInitialState()
Returns the initial business state of the business object described by this PropertyDescriptor. |
java.lang.Object |
getInitialValue()
Returns the initial value of the business object described by this PropertyDescriptor. |
java.lang.String |
getName()
Returns the name of this PropertyDescriptor. |
java.util.Hashtable |
getParameters()
Returns a hashtable with all the extra parameters of the PropertyDescription. |
Type |
getType()
Returns the Type of business object that this PropertyDescriptor describes. |
Validation |
getValidator()
Returns the validator responsible for handling validation of the business object. |
TypedData |
initializeInstance(TypedData businessObject)
Initializes the businessObject attributes |
void |
setConversion(Conversion converter)
Sets the converter which handles the default conversion type. |
void |
setConversion(java.lang.String conversionType,
Conversion converter)
Sets the converter that handles the specified conversion type. |
void |
setValidator(Validation validator)
Sets the validator to be employed by this PropertyDescriptor. |
java.lang.Object |
unformatFromReader(java.io.Reader reader,
java.lang.String conversionType)
Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type. |
java.lang.Object |
unformatFromReader(java.io.Reader reader,
java.lang.String conversionType,
java.util.Locale locale)
Constructs an Object of the correct Type using the specified conversion type, reader, and locale. |
java.lang.Object |
unformatFromString(java.lang.String value,
java.lang.String conversionType)
Converts the String passed to an Object using the appropriate conversion Type. |
java.lang.Object |
unformatFromString(java.lang.String value,
java.lang.String conversionType,
Hashtable parameters)
Converts the String to an Object using the appropriate conversion Type. |
java.lang.Object |
unformatFromString(java.lang.String value,
java.lang.String conversionType,
java.util.Locale locale)
Converts the String to an Object using the specified conversion Type and locale. |
java.lang.Object |
validate(java.lang.Object toValidate)
Validates the Object by first unformatting it and then applying its business rules. |
java.lang.Object |
validate(java.lang.Object toValidate,
boolean useState)
Validates the Object passed by first unformatting and then applying business rules. |
java.lang.Object |
validate(java.lang.Object toValidate,
Hashtable parameters)
Validates the Object passed by first unformatting and then applying business rules If successful, the method returns the Object. |
java.lang.Object |
validate(java.lang.Object toValidate,
java.lang.String convType)
Validates the Object passed by first unformatting using the convType conversion and then applying business rules. |
java.lang.Object |
validate(java.lang.Object toValidate,
java.lang.String convType,
boolean useState)
Validates the Object passed by first unformatting using the convType conversion and then applying business rules. |
java.lang.Object |
validate(java.lang.Object toValidate,
java.lang.String convType,
boolean useState,
Hashtable parameters)
Validates the Object passed by first unformatting using the convType conversion and then applying business rules. |
java.lang.Object |
validate(java.lang.Object toValidate,
java.lang.String convType,
Hashtable parameters)
Validates the Object passed by first unformatting using the convType conversion and then applying business rules. |
void |
validateParams()
Validates the parameters externaly defined for this descriptor |
void |
validateParams(Hashtable parameters)
Validates the parameters from the Hashtable passed as argument. |
Method Detail |
---|
void applyDefaultDescriptor(PropertyDescription descriptor) throws DSETypeException
descriptor
- PropertyDescription
DSETypeException
java.lang.Object cloneDescriptee(java.lang.Object value) throws DSETypeException
value
- Object
DSETypeException
java.lang.Object convertFrom(java.lang.Object obj) throws DSETypeException
obj
- java.lang.Object
-
- DSETypeException if the conversion type is not supported
DSETypeException
java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType) throws DSETypeException
obj
- java.lang.ObjectconvType
- java.lang.String
DSETypeException
- - Thrown if the conversion type is not supportedjava.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, boolean byReference) throws DSETypeException
DSETypeException
- - Thrown if the conversion type is not supportedjava.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale) throws DSETypeException
DSETypeException
- - Thrown if the conversion type is not supportedjava.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale, Hashtable parameters) throws DSETypeException
-
- DSETypeException if the conversion type is not supported
DSETypeException
java.lang.Object convertTo(java.lang.Object obj) throws DSETypeException
obj
- java.lang.Object
-
- DSETypeException Thrown if the conversion type is not supported
DSETypeException
java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType) throws DSETypeException
obj
- java.lang.ObjectconvType
- java.lang.String
DSETypeException
- - Thrown if the conversion type is not supportedjava.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, boolean byReference) throws DSETypeException
DSETypeException
- - Thrown if the conversion type is not supportedjava.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale) throws DSETypeException
DSETypeException
- - Thrown if the conversion type is not supportedjava.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale, Hashtable parameters) throws DSETypeException
DSETypeException
- Thrown if the conversion type is not supportedjava.lang.String formatToString(java.lang.Object value, java.lang.String conversionType) throws DSETypeException
value
- ObjectconversionType
- String
DSETypeException
- Thrown if the formatting is unsuccessful.java.lang.String formatToString(java.lang.Object value, java.lang.String conversionType, Hashtable parameters) throws DSETypeException
value
- ObjectconversionType
- Stringparameters
- com.ibm.btt.base.Hashtable
DSETypeException
- - Formatting is unsuccessfuljava.lang.String formatToString(java.lang.Object value, java.lang.String conversionType, java.util.Locale locale) throws DSETypeException
value
- ObjectconversionType
- Stringlocale
- Locale
DSETypeException
- - Formatting is unsuccessfulvoid formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer) throws DSETypeException
value
- ObjectconversionType
- Stringwriter
- Writer
DSETypeException
- - Formatting is unsuccessfulvoid formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer, java.util.Locale locale) throws DSETypeException
value
- ObjectconversionType
- Stringwriter
- Writerlocale
- Locale
DSETypeException
- - Formatting is unsuccessfulConversion getConversion(java.lang.String conversionType)
conversionType
- String
DSETypeException
- - Conversion type is already supportedjava.util.Enumeration getConverters()
java.lang.String getDescription()
java.lang.Class getImplClass() throws DSETypeException
DSETypeException
ElementState getInitialState()
java.lang.Object getInitialValue()
java.lang.String getName()
java.util.Hashtable getParameters()
Type getType()
Validation getValidator()
TypedData initializeInstance(TypedData businessObject) throws DSETypeException
businessObject
- com.ibm.btt.base.TypedData
DSETypeException
void setConversion(Conversion converter) throws DSETypeException
converter
- Conversion
DSETypeException
- - Conversion type is already supportedvoid setConversion(java.lang.String conversionType, Conversion converter) throws DSETypeException
conversionType
- Stringconverter
- Conversion
DSETypeException
- - Conversion type is already supportedvoid setValidator(Validation validator) throws DSETypeException
validator
- Validation
DSETypeException
- - Validator cannot validate the business object describedjava.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType) throws DSETypeException
reader
- ReaderconversionType
- String
DSETypeException
- - Unformatting is unsuccessful.java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType, java.util.Locale locale) throws DSETypeException
reader
- ReaderconversionType
- Stringlocale
- Locale
DSETypeException
- - Unformatting is unsuccessfuljava.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType) throws DSETypeException
value
- StringconversionType
- String
DSETypeException
- - Unformatting is unsuccessfuljava.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType, Hashtable parameters) throws DSETypeException
value
- StringconversionType
- Stringparameters
- com.ibm.btt.base.Hashtable
DSETypeException
- - Unformatting is unsuccessfuljava.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType, java.util.Locale locale) throws DSETypeException
value
- StringconversionType
- Stringlocale
- Locale
DSETypeException
- - Unformatting is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate) throws DSETypeException
toValidate
- Object
DSETypeException
- - Thrown if the validation is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate, Hashtable parameters) throws DSETypeException
toValidate
- Objectparameters
- com.ibm.btt.base.Hashtable
DSETypeException
- - Thrown if the validation is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate, java.lang.String convType) throws DSETypeException
toValidate
- ObjectconvType
- String
DSETypeException
- - Thrown if the validation is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate, java.lang.String convType, Hashtable parameters) throws DSETypeException
toValidate
- ObjectconvType
- Stringparameters
- com.ibm.btt.base.Hashtable
DSETypeException
- - Thrown if the validation is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate, java.lang.String convType, boolean useState) throws DSETypeException
toValidate
- ObjectconvType
- StringuseState
- boolean
DSETypeException
- Thrown if the validation is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate, java.lang.String convType, boolean useState, Hashtable parameters) throws DSETypeException
toValidate
- ObjectconvType
- StringuseState
- booleanparameters
- com.ibm.btt.base.Hashtable
DSETypeException
- - Thrown if the validation is unsuccessfuljava.lang.Object validate(java.lang.Object toValidate, boolean useState) throws DSETypeException
toValidate
- ObjectuseState
- boolean
DSETypeException
- - Thrown if the validation is unsuccessfulvoid validateParams() throws DSETypeException
DSETypeException
- Thrown if the parameter validation failsvoid validateParams(Hashtable parameters) throws DSETypeException
parameters
- com.ibm.btt.base.Hashtable
DSETypeException
- - Thrown if the parameter validation fails
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |