IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.cs.html.util
Class ICollUtil

java.lang.Object
  extended by com.ibm.btt.cs.html.util.ICollUtil

public class ICollUtil
extends java.lang.Object


Constructor Summary
ICollUtil()
           
 
Method Summary
static void updateErrorInfo(IndexedCollection icoll, java.lang.Object inputObject, DSETypeException e)
          Update the ErrorInfo attribute with the contents of the Exception
static java.lang.Object validate(IndexedCollection iColl)
          Validates the object passed (that must be an indexed collection) and if successful, the object is returned, otherwise an appropriate exception is thrown.
static java.lang.Object validate(IndexedCollection icoll, DataField toValidate)
          Validates the object passed (that must be a DataField) and if successful, the object is returned, otherwise an appropriate exception is thrown.
static java.lang.Object validate(IndexedCollection icoll, java.lang.Object toValidate)
          Validates the object passed (that must be an indexed collection or a vector) and if successful, the object is returned, otherwise an appropriate exception is thrown.
static java.lang.Object validate(IndexedCollection icoll, Vector elements)
          Validates the set of objects passed (that must be DataField's) and if successful, the set is returned, otherwise an appropriate exception is thrown.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ICollUtil

public ICollUtil()
Method Detail

updateErrorInfo

public static void updateErrorInfo(IndexedCollection icoll,
                                   java.lang.Object inputObject,
                                   DSETypeException e)
Update the ErrorInfo attribute with the contents of the Exception

Parameters:
inputObject - Object
e - DSETypeException

validate

public static java.lang.Object validate(IndexedCollection icoll,
                                        java.lang.Object toValidate)
                                 throws DSETypeException
Validates the object passed (that must be an indexed collection or a vector) and if successful, the object is returned, otherwise an appropriate exception is thrown.

Parameters:
icoll - IndexedCollection
toValidate - Object
Throws:
DSETypeException - Thrown if the validation is unsuccessful.

validate

public static java.lang.Object validate(IndexedCollection icoll,
                                        DataField toValidate)
                                 throws DSETypeException
Validates the object passed (that must be a DataField) and if successful, the object is returned, otherwise an appropriate exception is thrown. The DataField contains the name of the final DataField that must be created in the IndexedCollection. The format of the name should be: index+"."+"path to the final DataField" This method will: - Create as many elements in the iColl as needed to have an element at the index passed as the name of the element. - Let the new created DataField to validate the input value - If validation succeeds, the field is kept in the IColl - Otherwise, the ErrorInfo object of the IColl is updated with the Exception contents and the DataField is removed (only if it was created)

Parameters:
toValidate - DataField
Returns:
java.lang.Object
Throws:
DSETypeException - Thrown if the validation is unsuccessful.

validate

public static java.lang.Object validate(IndexedCollection iColl)
                                 throws DSETypeException
Validates the object passed (that must be an indexed collection) and if successful, the object is returned, otherwise an appropriate exception is thrown.

Parameters:
iColl - Object
Throws:
DSETypeException - Thrown if the validation is unsuccessful.

validate

public static java.lang.Object validate(IndexedCollection icoll,
                                        Vector elements)
                                 throws DSETypeException
Validates the set of objects passed (that must be DataField's) and if successful, the set is returned, otherwise an appropriate exception is thrown. The DataField's contain the name of the final DataField that must be created in the IndexedCollection. The format of the name should be: index+"."+"path to the final DataField" This method will: - Create the elements inside this IColl, unless they already exist - Let the new created DataFields to validate the input value - If validation succeeds, the fields are kept in the IColl - Otherwise, the ErrorInfo object of the IColl is updated with the Exception contents and the DataFields are removed (only if they were created)

Parameters:
elements - Vector
Returns:
java.lang.Object
Throws:
DSETypeException - Thrown if the validation is unsuccessful.

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011