com.sapportals.wcm.repository
Class PropertySelectorItem

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.repository.PropertySelectorItem

public final class PropertySelectorItem

extends java.lang.Object

Since:

EP5, SP6, Patch1, Hotfix1; EP6, SP2_CP This class defines a selection criteria based on a single property. Depending on its include-Attribute, it will either let each resource that fulfills the property pass this filter or fail this filter. This selector class can also handle multi valued properties.

Constructor Summary

PropertySelectorItem(boolean include, IProperty property)

Method Summary

IPropertyName	getPropertyName()
boolean	pass(IProperty checkProp) checks, if the given property will pass this selector or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySelectorItem

public PropertySelectorItem(boolean include,
                            IProperty property)

Parameters:

include - flag to define, how the #pass(IProperty prop) method will behave: if it is set to true, only resources that have the required property will pass. If it is set to false, only resources that have the required property will not pass.

property - the property to check. Must not be null

Method Detail

getPropertyName

public IPropertyName getPropertyName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

pass

public boolean pass(IProperty checkProp)
             throws ResourceException

checks, if the given property will pass this selector or not. Behavior varies, depending on
the value of the global include-attribute set in the constructor
if it is a multi valued property or a single valued property.
If the property-types of this class and the provided property do not match, this method will always return false.
Include mode set to true: if the checkProp-parameter is null, the method will return false If the checkProp equals the property of this class or one of the values of the checkProp equals one of the values of the property of this class, the method will return true.
Include mode set to false: If the checkProp-parameter is null, the method will return true If the checkProp equals the property of this class or one of the values of the checkProp equals one of the values of the property of this class, the method will return false.

Parameters:

checkProp - the property to check, might be null

Returns:

flag, indicating if the given property will pass this selector

Throws:

ResourceException -