FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Class SearchPropInfo

java.lang.Object
  extended bycom.filenet.wcm.api.SearchPropInfo

public class SearchPropInfo
extends java.lang.Object

Not Applicable in CS Java Connector v3.0.

This class carries information about Content Services properties for search purposes. Use an array of SearchPropInfo elements to pass a set of class names and property names to methods in the Search interface that retrieve property descriptions for specific classes and properties. For example, when you call the forms of getPropertyDescriptions on the Search interface that take a propInfo parameter, you pass an array of SearchPropInfo elements to the method. Each element contains the symbolic names of a class and a property.

The following code fragment creates an array of SearchPropInfo elements for retrieving "SearchType" and "SearchingObjectType" properties of StoredSearch class.

SearchPropInfo[] propInfo = new SearchPropInfo[]
 {new SearchPropInfo("StoredSearch", "SearchType"),
  new SearchPropInfo("StoredSearch", "SearchingObjectType")}; 

Typically, you pass in non-empty values for class name and property name to identify a specific property. But you can also pass in an empty value for either a class name or a property name. For example, if the class name is not empty but the property name is empty, all property descriptions belonging to the specified class name will be returned. If the class name is empty but the property name is not empty, all property descriptions with the specified property name belonging to any class will be returned. If an array element's class name and property name are both empty, the element will be ignored.


Constructor Summary
SearchPropInfo(java.lang.String strClassName, java.lang.String strPropName)
          

Not Applicable in CS Java Connector v3.0.

 
Method Summary
 java.lang.String getClassName()
          

Not Applicable in CS Java Connector v3.0.

 java.lang.String getPropName()
          

Not Applicable in CS Java Connector v3.0.

 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchPropInfo

public SearchPropInfo(java.lang.String strClassName,
                      java.lang.String strPropName)

Not Applicable in CS Java Connector v3.0.

Creates an instance of SearchPropInfo, initializing it with the specified symbolic names for the class and the property.

Parameters:
strClassName - A String that represents the symbolic name of a Content Services class. Defaults to null.

strPropName - A String that represents the symbolic name of a Content Services property. Defaults to null.
Method Detail

getClassName

public java.lang.String getClassName()

Not Applicable in CS Java Connector v3.0.

Returns a String that represents the symbolic name of the class specified in this SearchPropInfo element.


getPropName

public java.lang.String getPropName()

Not Applicable in CS Java Connector v3.0.

Returns a String that represents the symbolic name of the property specified in this SearchPropInfo element.


FileNet Content Services
Java Connector v3.0