|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.search.SearchQualification | +--oracle.ifs.search.FolderRestrictQualification
The FolderRestrictQualification(FRQ) represents a condition to restrict the Search to a particular area of the folder Hierarchy. FRQs apply only to classes that can be foldered.
A FRQ is represented by the Search Class and a Folder. The Folder represents the root of the hierarchy under consideration. Users can also specify the depth of the Search. For e.g. a depth of 2 implies only objects that are upto 2 levels below the Start Folder should be considered. The default is to consider objects to an unlimited depth.
FRQs are converted into a SubSelect containing a 'connect-by' clause in SQL. Such queries are expensive, and should be used judiciously.
Constructor Summary | |
FolderRestrictQualification()
Constructs an AttributeQualification. |
Method Summary | |
int |
getMaxLevels()
Return the number of levels that will be traversed. |
java.lang.String |
getSearchClassname()
Returns the Search Class. |
java.lang.String |
getStartFolder()
Returns the startFolder. |
void |
setMaxLevels(int maxlvl)
Set the traversal depth. |
void |
setSearchClassname(java.lang.String className)
Sets the SearchClass. |
void |
setStartFolder(AttributeValue av)
Sets the startFolder. |
void |
setStartFolder(Folder folder)
Sets the startFolder. |
void |
setStartFolder(java.lang.String value)
Sets the startFolder. |
Methods inherited from class oracle.ifs.search.SearchQualification |
clone |
Constructor Detail |
public FolderRestrictQualification()
Method Detail |
public void setSearchClassname(java.lang.String className)
className
- The class of the attributeSearchSpecification
,
SearchClassSpecification
public java.lang.String getSearchClassname()
public void setStartFolder(java.lang.String value) throws IfsException
value
- the id of the start Folder.IfsException
- 22002 if value is null.public void setStartFolder(AttributeValue av) throws IfsException
value
- the start Folder.IfsException
- 22002 if value is null.public void setStartFolder(Folder folder) throws IfsException
value
- the start Folder.IfsException
- 22002 if value is null.public java.lang.String getStartFolder()
public void setMaxLevels(int maxlvl) throws IfsException
maxlvl
- represents the depth of the traversal.public int getMaxLevels()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |