com.filenet.wcm.toolkit.server.util.xml
Class SearchChoiceListUtil

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.SearchChoiceListUtil

public class SearchChoiceListUtil
extends java.lang.Object

SearchChoiceListUtil class provides utility methods for merging Search Choice Values list XML.


Nested Class Summary
static class SearchChoiceListUtil.ChoiceListItem
          This class is a data structure of the returned choice list item used by the getChoiceValuesList method.
static class SearchChoiceListUtil.ClassDescriptionRef
          This class is a data structure used by the getClassDescriptionList method for flatten out the classes.
 
Constructor Summary
SearchChoiceListUtil(java.lang.String URL, java.lang.String token, java.lang.String cookie)
          Deprecated.  
SearchChoiceListUtil(WcmDataStore dataStore, WcmBootstrapPrefs bootstrapPrefs)
           
 
Method Summary
static void clear()
          Clear the search choice list state
 java.util.List getChoiceValuesList(java.lang.String objectStoreName, java.util.List classNames, java.lang.String propName)
          This method returns the merged choice value list for the selected property and classes.
 java.util.List getChoiceValuesList(java.lang.String objectStoreName, java.util.List classNames, java.lang.String propName, boolean retrieveFromServer)
          This method returns the merged choice value list for the selected property and classes.
 java.util.TreeMap getChoiceValuesListProxy(java.lang.String objectStoreName, java.util.List classNames, java.lang.String propName, boolean retrieveFromServer)
          Deprecated.  
 java.util.List getClassDescriptionList(java.lang.String objectStoreName, java.util.List classDescriptionRefs)
          This method returns a list of flatten class name for the choice list merge.
 java.lang.String getClassName(java.lang.String objectStoreName, java.lang.String classId)
          This method returns the class name
 boolean getscvlShowChoiceValue()
          Deprecated.  
 boolean isSearchChoiceListXMLExisted()
          Returns true to indicate that the search choice value list existed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchChoiceListUtil

public SearchChoiceListUtil(WcmDataStore dataStore,
                            WcmBootstrapPrefs bootstrapPrefs)
                     throws java.lang.Exception

SearchChoiceListUtil

public SearchChoiceListUtil(java.lang.String URL,
                            java.lang.String token,
                            java.lang.String cookie)
                     throws java.lang.Exception
Deprecated.  

Parameters:
URL -
token -
cookie -
Throws:
java.lang.Exception
Method Detail

getscvlShowChoiceValue

public boolean getscvlShowChoiceValue()
Deprecated.  


getChoiceValuesList

public java.util.List getChoiceValuesList(java.lang.String objectStoreName,
                                          java.util.List classNames,
                                          java.lang.String propName)
                                   throws java.lang.Exception
This method returns the merged choice value list for the selected property and classes.

Parameters:
objectStoreName - String The objectstore name.
classNames - List A list of class names.
propName - String The property symbolic name.
Returns:
List A choice value list.
Throws:
java.lang.Exception

getChoiceValuesList

public java.util.List getChoiceValuesList(java.lang.String objectStoreName,
                                          java.util.List classNames,
                                          java.lang.String propName,
                                          boolean retrieveFromServer)
                                   throws java.lang.Exception
This method returns the merged choice value list for the selected property and classes. If the Search Choice Value List XML is invalid or not found then the java API ChoiceList will be returned.

Parameters:
objectStoreName - String The objectstore name.
classNames - List A list of class names.
propName - String The property symbolic name.
retrieveFromServer - True to retrieve choice list from server if the Search Choice Value List XML is not found.
Returns:
List A choice value list or a java API ChoiceList list.
Throws:
java.lang.Exception

getChoiceValuesListProxy

public java.util.TreeMap getChoiceValuesListProxy(java.lang.String objectStoreName,
                                                  java.util.List classNames,
                                                  java.lang.String propName,
                                                  boolean retrieveFromServer)
                                           throws java.lang.Exception
Deprecated.  

Parameters:
objectStoreName -
classNames -
propName -
retrieveFromServer -
Returns:
Throws:
java.lang.Exception

isSearchChoiceListXMLExisted

public boolean isSearchChoiceListXMLExisted()
Returns true to indicate that the search choice value list existed.

Returns:
boolean True to indicate that a valid choice list XML existed.

clear

public static void clear()
Clear the search choice list state


getClassDescriptionList

public java.util.List getClassDescriptionList(java.lang.String objectStoreName,
                                              java.util.List classDescriptionRefs)
                                       throws java.lang.Exception
This method returns a list of flatten class name for the choice list merge.

Parameters:
objectStoreName - String The objectstore name.
classDescriptionRefs - List A list of ClassDescriptionRef objects.
Returns:
List A list of class names.
Throws:
java.lang.Exception

getClassName

public java.lang.String getClassName(java.lang.String objectStoreName,
                                     java.lang.String classId)
                              throws java.lang.Exception
This method returns the class name

Parameters:
objectStoreName - String The objectstore name.
classId - String The class Id
Returns:
String The class name
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.