|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.api.SearchClassInfo
Not Applicable in CS Java Connector v3.0.
This class carries information about Content Services classes for search purposes. Use an array ofSearchClassInfo
elements to pass a set
of class names to the Search
interface
methods that retrieve property descriptions for specific classes.
For example, when you call the forms of getPropertyDescriptions
on the
Search
interface that take a classInfo
parameter,
you pass an array of SearchClassInfo
elements to the method.
Each element contains the symbolic name of a class and a bIncludeSubclasses
flag. If the flag is true
(the default), the method returns all
of the property descriptions for the specified class as well as the properties
of its subclasses. If the flag is false
, the method
returns all of the property descriptions for the specified class but does not
return the property descriptions of the class's subclasses.
The following code fragment creates an array of SearchClassInfo
elements for
retrieving properties of StoredSearch
and PublishTemplate
classes but not the properties of their subclasses.
SearchClassInfo[] classInfo = new SearchClassInfo[]
{new SearchClassInfo("StoredSearch", false),
new SearchClassInfo("PublishTemplate", false)};
However, if in addition to a class's properties, you also want to
retrieve the properties of its subclasses, specify true
for the
bIncludeSubclasses
flag. The following code fragment retrieves
properties for StoredSearch
and PublishTemplate
classes, and the properties for the subclasses of those classes.
The code fragment below constructs the functional equivalent of
the SearchClassInfo[] classInfo = new SearchClassInfo[]
{new SearchClassInfo("StoredSearch", true),
new SearchClassInfo("PublishTemplate", true)};
SearchClassInfo
elements shown in the previous example.
In this case, the bIncludeSubclasses
flag is assigned the
default value of true
:
SearchClassInfo[] classInfo = new SearchClassInfo[]
{new SearchClassInfo("StoredSearch"),
new SearchClassInfo("PublishTemplate")};
Constructor Summary | |
SearchClassInfo(java.lang.String strClassName)
Not Applicable in CS Java Connector v3.0. |
|
SearchClassInfo(java.lang.String strClassName,
boolean bIncludeSubclasses)
Not Applicable in CS Java Connector v3.0. |
Method Summary | |
java.lang.String |
getClassName()
Not Applicable in CS Java Connector v3.0. |
boolean |
getIncludeSubclasses()
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 |
public SearchClassInfo(java.lang.String strClassName, boolean bIncludeSubclasses)
Not Applicable in CS Java Connector v3.0.
Creates an instance ofSearchClassInfo
, initializing
it with the specified symbolic name for the class and
the specified value for the bIncludeSubclasses
flag.
strClassName
- A String that represents the symbolic name of a
Content Services class. Defaults to null
.
bIncludeSubclasses
- If true
(the default), properties
for the class's subclasses are retrieved; if false
, only the
properties for the specified class are retrieved.public SearchClassInfo(java.lang.String strClassName)
Not Applicable in CS Java Connector v3.0.
Creates an instance ofSearchClassInfo
, initializing
it with the specified symbolic name for the class. The
bIncludeSubclasses
flag defaults to true
.
strClassName
- A String
that represents the symbolic
name of a Content Services class. Defaults to null
.Method Detail |
public java.lang.String getClassName()
Not Applicable in CS Java Connector v3.0.
Returns aString
that represents the symbolic name of the
class specified in this SearchClassInfo
element.
public boolean getIncludeSubclasses()
Not Applicable in CS Java Connector v3.0.
Returns the boolean value of thebIncludeSubclasses
flag
specified in this SearchClassInfo
element.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |