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

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

public class SearchExecuteData
extends java.lang.Object

This class is used to generate XML to pass into StoredSearch.executeXML() method


Nested Class Summary
 class SearchExecuteData.CommonObjectTypeData
          This class extends ObjectTypesData.
 class SearchExecuteData.ObjectTypeData
          This class represents search criteria for each individual object type.
 class SearchExecuteData.SelectedFolder
          Class representing selected folder criteria
 
Field Summary
 SearchExecuteData.ObjectTypeData commonCriteria
           
 SearchExecuteData.ObjectTypeData customObjectCriteria
           
 SearchExecuteData.ObjectTypeData documentCriteria
           
 SearchExecuteData.ObjectTypeData folderCriteria
           
 
Constructor Summary
SearchExecuteData()
          Creates a new instance of SearchExecuteData object.
 
Method Summary
 void addFolder(java.lang.String id, java.lang.String pathname, java.lang.String objectStoreName, java.lang.String itemId)
          Adds a folder to the search execute data xml
 SearchExecuteData.ObjectTypeData getObjectTypeData(java.lang.String objectType)
          Returns an instance of ObjectTypeData object for the given object type
 org.w3c.dom.Document getXML()
          Returns executedata XML
 org.w3c.dom.Document getXML(java.util.Locale locale)
          Returns executedata XML
 void setMaxRecords(int maxRecords)
          Sets the maximum number of records returned by this search
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

documentCriteria

public SearchExecuteData.ObjectTypeData documentCriteria

folderCriteria

public SearchExecuteData.ObjectTypeData folderCriteria

customObjectCriteria

public SearchExecuteData.ObjectTypeData customObjectCriteria

commonCriteria

public SearchExecuteData.ObjectTypeData commonCriteria
Constructor Detail

SearchExecuteData

public SearchExecuteData()
Creates a new instance of SearchExecuteData object.

Method Detail

setMaxRecords

public void setMaxRecords(int maxRecords)
Sets the maximum number of records returned by this search

Parameters:
maxRecords -

addFolder

public void addFolder(java.lang.String id,
                      java.lang.String pathname,
                      java.lang.String objectStoreName,
                      java.lang.String itemId)
Adds a folder to the search execute data xml

Parameters:
id - folder id
pathname - folder path name (optional)
objectStoreName -
itemId -

getObjectTypeData

public SearchExecuteData.ObjectTypeData getObjectTypeData(java.lang.String objectType)
Returns an instance of ObjectTypeData object for the given object type

Parameters:
objectType -

getXML

public org.w3c.dom.Document getXML(java.util.Locale locale)
                            throws java.lang.Exception
Returns executedata XML

Returns:
XML Document
Throws:
java.lang.Exception

getXML

public org.w3c.dom.Document getXML()
                            throws java.lang.Exception
Returns executedata XML

Returns:
XML Document
Throws:
java.lang.Exception


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