com.filenet.wcm.apps.server.util

Class FormSearchUtil

  1. java.lang.Object
  2. extended bycom.filenet.wcm.apps.server.util.FormSearchUtil
  1. public class FormSearchUtil
  2. extends java.lang.Object

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
 CURRENT_VERSION
  1. static
  2. int
 LOGICAL_AND
  1. static
  2. int
 LOGICAL_OR
  1. static
  2. java.lang.String[]
 operatorList
  1. static
  2. int
 RELEASED

Constructor Summary

Constructor and Description
FormSearchUtil()

Method Summary

Modifier and Type Method and Description
  1. void
 addPropertyCriteria(java.lang.String propertyName,int propertyType,int operator,java.lang.String propertyValue,int logicalOperator)
Adds new search criteria to the criteria list.
  1. void
 addSelectProperty(java.lang.String propertyName)
Adds additional property to the select property list.
  1. java.util.List
 getCriteria()
Returns the search criteria list
  1. int
 getCriteriaCount()
Returns the total criteria items.
  1. java.lang.String
 getSQL(int objectType)
Builds and returns the sql string based on the selected select properties and selected search criteria.
  1. void
 setDocumentVersion(int searchVersionStatus)
Sets to limit the query to either a released version or the current version.
  1. void
 setFilterClass(java.lang.String searchFilterClass)
Sets to limit the query to document specified by the parameter class.
  1. void
 setMaxResults(int searchMaxResults)
Set the maximum number of returned items.
  1. void
 setQueryObjectStore(java.lang.String searchObjectStore)
Set the selected object store.
  1. void
 setSelectClause(java.lang.String searchSelectClause)
Sets the select clause to overide the default select clause.
  1. void
 setSelectProperties(java.lang.String[] properties)
Sets the select properties.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGICAL_OR

  1. public static final int LOGICAL_OR
See Also:
Constant Field Values

LOGICAL_AND

  1. public static final int LOGICAL_AND
See Also:
Constant Field Values

CURRENT_VERSION

  1. public static final int CURRENT_VERSION
See Also:
Constant Field Values

RELEASED

  1. public static final int RELEASED
See Also:
Constant Field Values

operatorList

  1. public static final java.lang.String[] operatorList

Constructor Detail

FormSearchUtil

  1. public FormSearchUtil()

Method Detail

setSelectProperties

  1. public void setSelectProperties( java.lang.String[] properties)
Sets the select properties.

The default properties for a document query are:

VersionSeries, OIID, Id, MimeType, ObjectType, IsReserved, IsCurrentVersion, Creator, DateCreated, LastModifier, DateLastModified, DocumentTitle, MajorVersionNumber, MinorVersionNumber and VersionStatus

Parameters:
properties - String[] The list of selected properties.

setQueryObjectStore

  1. public void setQueryObjectStore( java.lang.String searchObjectStore)
Set the selected object store.
Parameters:
searchObjectStore - String The object store name.

setMaxResults

  1. public void setMaxResults(int searchMaxResults)
Set the maximum number of returned items.
Parameters:
searchMaxResults - inn The maximum number of returned item.

setFilterClass

  1. public void setFilterClass(java.lang.String searchFilterClass)
Sets to limit the query to document specified by the parameter class.
Parameters:
searchFilterClass - String The filter class name.

setDocumentVersion

  1. public void setDocumentVersion( int searchVersionStatus)
Sets to limit the query to either a released version or the current version.
Parameters:
searchVersionStatus - int The version types defined by this class (RELEASE = 1 and CURRENT = 2)

setSelectClause

  1. public void setSelectClause(java.lang.String searchSelectClause)
Sets the select clause to overide the default select clause.
Parameters:
searchSelectClause - String The new select clause.

addSelectProperty

  1. public void addSelectProperty(java.lang.String propertyName)
Adds additional property to the select property list.
Parameters:
propertyName - String The selected property name.

addPropertyCriteria

  1. public void addPropertyCriteria( java.lang.String propertyName,
  2. int propertyType,
  3. int operator,
  4. java.lang.String propertyValue,
  5. int logicalOperator)
Adds new search criteria to the criteria list.
Parameters:
propertyName - String The selected property name.
propertyType - int The selected property type.
operator - int The property query operator.
propertyValue - String The selected property value.
logicalOperator - String The logical operator to be used between the selected properties.

getSQL

  1. public java.lang.String getSQL( int objectType)
Builds and returns the sql string based on the selected select properties and selected search criteria.
Parameters:
objectType - int The object type.
Returns:
String The search sql statement.

getCriteriaCount

  1. public int getCriteriaCount()
Returns the total criteria items.
Returns:
int The count of the selected properties in the criteria list.

getCriteria

  1. public java.util.List getCriteria( )
Returns the search criteria list
Returns:
List The search criteria list.