com.togethersoft.openapi.model.extension
Interface PropertySetProvider

public interface PropertySetProvider

extends PropertyProvider

Provider, which implements this interface, is responsible for property writing operations.

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

addProperty

public Property addProperty(PropertyMap propertyMap, String propertyName, String propertyValue)

Provider must add property with a specified value to propertyMap. This method is
called only when
isApplicable and canAddProperty methods of provider was
invoked and both returned true.
This method is invoked for every provider registered in the model, which returned
true both by isApplicable and canAddProperty methods.

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

Provider must return true, if propertyName property with
propertyValue value can be added to propertyMap
This method is called, when canAddProperty method of PropertyMap was
invoked or before addProperty method invokation.
The result of collaborative execution of this method for multiple
providers registered in the model is false, when all applicable providers
returned false and true otherwise.

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

Provider must return true if propertyName property can be set
to the propertyValue value.
This method is called, when canSetPropertyValue method of PropertyMap
was invoked or before setPropertyValue method invokation.
The result of collaborative execution of this method for multiple
providers registered in the model is false, when all applicable providers
returned false and true otherwise.

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

See descriprtion of canSetPropertyValue(PropertyMap propertyMap, String propertyName, String propertyValue)

public boolean isPropertyWritable(PropertyMap propertyMap, String propertyName)

Provider must return true if propertyName property is writable.
This method is called, when isPropertyWritable method of PropertyMap
was invoked. The result of collaborative execution of this method for multiple
providers registered in the model is false, when all applicable providers
returned false and true otherwise.

public void setPropertyValue(PropertyMap propertyMap, String propertyName, String propertyValue)

Provider must set property with a specified value. This method is called only when
isApplicable and canSetPropertyValue methods of provider was
invoked and both returned true.
This method is invoked for every provider registered in the model, which returned
true both from isApplicable and canSetPropertyValue methods.

public void setPropertyValue(PropertyMap propertyMap, String propertyName, boolean propertyValue)

See description of setPropertyValue(PropertyMap propertyMap, String propertyName, String propertyValue)
method.