com.togethersoft.openapi.model.extension
Interface PropertyGetProvider

public interface PropertyGetProvider

extends PropertyProvider

Provider, implementing this interface takes a responsibilty for property listing and retrieving.

Provider itself can request properties of PropertyMap
via regular interface. Actually, from the provider's point of view,
PropertyMap would behave like there
are only property providers, which are registered before this one.

When any method of provider is called, it's guaranteed, that isApplicable method
was called before
with the same values of propertyMap and propertyName
arguments and true was returned.

Author:

TogetherSoft

Method Detail

getProperty

public Property getProperty(PropertyMap propertyMap, String propertyName)

Will be called, when getProperty operation of PropertyMap was invoked.
All providers will be polled sequentially until anyone of them returned not null value or all
providers returned null.

Returns: object, which implements Property interface for requested property
or null if there is no such property in propertyMap from provider's
point of view

public String getPropertyValue(PropertyMap propertyMap, String propertyName)

Will be called, when getPropertyValue operation of PropertyMap was invoked.
All providers will be polled sequentially until anyone of them returned not null value or all providers returned null.

Returns: not null value or null if there is no such property
in propertyMap from provider's point of view

public boolean hasProperty(PropertyMap propertyMap, String propertyName)

Will be called, when hasProperty operation of PropertyMap was invoked.
All providers will be polled sequentially until next returned true or all providers
returned false.

Parameters:

stringName specifies requested property

Returns: true when provider provides such property for this propertyMap

public boolean hasPropertyValue(PropertyMap propertyMap, String propertyName, String propertyValue)

Will be called, when hasPropertyValue operation of PropertyMap was
invoked. All providers will be polled sequentially until next returned true or
all providers returned false.

Parameters:

stringName specifies requested property

Returns: true if this provider provides property with such name and current
PropertyMap instance has property with such value.

public boolean isPropertyReadable(PropertyMap propertyMap, String propertyName)

Will be called, when isPropertyReadable operation of PropertyMap was invoked.
All providers will be polled sequentially until anyone of them returned true or all providers returned false.

Parameters:

stringName specifies requested property

Returns: true if this provider provides readable property with such name

public PropertyEnumeration properties(PropertyMap propertyMap)

Will be called, when properties() operation of PropertyMap was invoked.
Every providers will be polled and all enumerations returned by providers, united into
one will be returned.

isApplicable method is guaranteed to be called before with the same value of
propertyMap argument and null as value of propertyName
argument.

Returns: PropertyEnumeration of proeprties in this PropertyMap.

public PropertyEnumeration properties(PropertyMap propertyMap, String propertyName)

Will be called, when properties(String propertyName) operation of PropertyMap was invoked.
Every providers will be polled and all enumerations returned by providers, united into
one will be returned.

Returns: PropertyEnumeration of proeprties in this PropertyMap.