com.sap.netweaver.bc.rf.common.namespace

Class AdvancedDeepFindResourcesDescriptor

java.lang.Object
  com.sap.netweaver.bc.rf.common.namespace.AbstractFindResourcesDescriptor
      com.sap.netweaver.bc.rf.common.namespace.BasicChildrenFindResourcesDescriptor
          com.sap.netweaver.bc.rf.common.namespace.AdvancedChildrenFindResourcesDescriptor
              com.sap.netweaver.bc.rf.common.namespace.AdvancedDeepFindResourcesDescriptor

All Implemented Interfaces:

IAdvancedChildrenFindResourcesDescriptor, IAdvancedDeepFindResourcesDescriptor, IBasicChildrenFindResourcesDescriptor, IFindResourcesDescriptor

Direct Known Subclasses:

AdvancedDeepVersionedFindResourcesDescriptor

public class AdvancedDeepFindResourcesDescriptor
extends AdvancedChildrenFindResourcesDescriptor
implements IAdvancedDeepFindResourcesDescriptor

Class implementing a find descriptor for resources supporting find operations for different depths. A depth of n always incldues the resources at the lower n-1 levels, i.e. at a depth of 1, also the root resource is meant (in contrast to find children operations); the behavior is only defined for the values 0, 1 and MAX(INTEGER); the support of the depths 0 and 1 is mandatory; for all other values a definition could be found, but the definiton would exceed the functionality of many so far known repositories (DASL conform repositories) and it's support might be difficult to inquire (in case of a remote repository).

Field Summary

protected int

depth

Fields inherited from class com.sap.netweaver.bc.rf.common.namespace.AdvancedChildrenFindResourcesDescriptor

collator, queryExpression

Constructor Summary

AdvancedDeepFindResourcesDescriptor(IQueryExpression queryExpression, ICollator collator, int depth)
Construct object of class FindAdvancedDeepResourcesDescriptor.

Method Summary

int

getDepth() Get depth to be used to find resources at the given depth and all levels below this depth, i.e. at a depth of 1, also the root resource is meant (in contrast to find children operations); the behavior is only defined for the values 0, 1 and MAX(INTEGER); the support of the depths 0 and 1 is mandatory; for all other values a definition could be found, but the definiton would exceed the functionality of many so far known repositories (DASL conform repositories) and it's support might be difficult to inquire (in case of a remote repository).

Methods inherited from class com.sap.netweaver.bc.rf.common.namespace.AdvancedChildrenFindResourcesDescriptor

getCollator, getQueryExpression

Methods inherited from class com.sap.netweaver.bc.rf.common.namespace.BasicChildrenFindResourcesDescriptor

findCollections, findHidden, findLinks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.netweaver.bc.rf.common.namespace.IAdvancedChildrenFindResourcesDescriptor

getCollator, getQueryExpression

Field Detail

depth

protected int depth

Constructor Detail

AdvancedDeepFindResourcesDescriptor

public AdvancedDeepFindResourcesDescriptor(IQueryExpression queryExpression,
                                           ICollator collator,
                                           int depth)

Construct object of class FindAdvancedDeepResourcesDescriptor.

Parameters:

queryExpression - query expression

collator - collator

depth - depth

Method Detail

getDepth

public int getDepth()

Get depth to be used to find resources at the given depth and all levels below this depth, i.e. at a depth of 1, also the root resource is meant (in contrast to find children operations); the behavior is only defined for the values 0, 1 and MAX(INTEGER); the support of the depths 0 and 1 is mandatory; for all other values a definition could be found, but the definiton would exceed the functionality of many so far known repositories (DASL conform repositories) and it's support might be difficult to inquire (in case of a remote repository).

Specified by:

getDepth in interface IAdvancedDeepFindResourcesDescriptor

Returns:

depth

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM