public final class Selector extends Object
Copyright SAP AG 2004
PropertySelectorItem
instances. Its type constants define
how selection instances are combined.Modifier and Type | Field and Description |
---|---|
static com.sapportals.wcm.repository.Selector.Type |
SELECTOR_AND |
static com.sapportals.wcm.repository.Selector.Type |
SELECTOR_OR |
static int |
SELECTOR_TYPE_AND |
static int |
SELECTOR_TYPE_OR |
Constructor and Description |
---|
Selector()
standard constructor - will create a new class instance with selectortype
SELECTOR_AND . |
Selector(com.sapportals.wcm.repository.Selector.Type type)
creates a new class instance with the specified selectortype.
|
Modifier and Type | Method and Description |
---|---|
void |
addSelector(boolean include,
IProperty property)
creates a new
PropertySelectorItem using the specified parameters |
void |
addSelector(PropertySelectorItem selector) |
void |
addSelector(Selector selector) |
boolean |
check(IPropertyMap properties)
checks, if the provided map of properties will pass all
PropertySelectorItem
instances defined within this class. |
PropertyNameList |
getPropertyNameList() |
com.sapportals.wcm.repository.Selector.Type |
getSelectorType() |
boolean |
isEmpty() |
String |
toString() |
public static final int SELECTOR_TYPE_AND
public static final int SELECTOR_TYPE_OR
public static final com.sapportals.wcm.repository.Selector.Type SELECTOR_AND
public static final com.sapportals.wcm.repository.Selector.Type SELECTOR_OR
public Selector(com.sapportals.wcm.repository.Selector.Type type)
type
- If the type is null
, the default
selectortype SELECTOR_AND
will be usedpublic Selector()
SELECTOR_AND
.public void addSelector(boolean include, IProperty property)
PropertySelectorItem
using the specified parametersinclude
- the include mode for the PropertySelectorItem
property
- the property for the PropertySelectorItem
- must not be null
public void addSelector(PropertySelectorItem selector)
selector
- is added to the list of selectors - must not be null
public void addSelector(Selector selector)
selector
- is added to the list of selectors - must not be null
public com.sapportals.wcm.repository.Selector.Type getSelectorType()
public boolean isEmpty()
Selector
or PropertySelectorItem
has been added to this class. If not, the method will return true
.public PropertyNameList getPropertyNameList()
PropertySelectorItem
instances that have been added to this instance.
Also the Property names of PropertySelectorItem
instances that are included
in the Selector
instances added to this instance are added. The current
implmentation does not check for duplicates within the list. null
public boolean check(IPropertyMap properties) throws ResourceException
PropertySelectorItem
instances defined within this class. Depending on the combination of these instances and
other Selector
instances within this class, not all tests will be executed
to calculate the result of this method. If, for example, already the first test fails and
the Selector.Type
of this class is set to SELECTOR_AND
, the
method will return false
without evaluating further propertiesproperties
- the properties to check, must not be null
, but might be emptyResourceException
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice