APIs for multivalue properties

APIs for multivalue properties

Use the com.ibm.websphere.personalization.resources.IMVResource interface to enable mapping multi-value properties. Use the com.ibm.websphere.personalization.resources.IMultiValueUtils interface for retrieving multi-value properties when those resources are in a database.
The com.ibm.websphere.personalization.resources.IMVResource interface extends the Resource interface and enables mapping multi-value properties. Implementing this interface is only required when an IMultiValueUtils implementation is used by the ResourceManager3. Default case for resources generated with the Portal tools, but may not be necessary for custom resources.

Method Explanation
setMultiValueUtils(IMultiValueUtils instance) Saves the reference to the instance of MultiValueUtils. That reference is used when invoking the fillinMultiValueProperties method of the MultiValueUtils class. This method does not return output.
addMultiValuePropertyValue(String propertyname, Object propertyvalue) Enables the IMVResource instance to add values for multi-value properties. This method does not return output.

The interface com.ibm.websphere.personalization.resources.IMultiValueUtils is a set of utilities for retrieving multi-value properties when those resources are in a database. This class supports mapping multi-value properties to the corresponding database tables.

Method Explanation
convertSQLtoMultiValue(String query) Converts the SQL query string for ResourceManager3 classes that need to search on single value and multi-value properties. Returns an enumeration containing the converted where clause followed by one or more elements containing the table names that are involved in the query.
populateJoinedProperties(IMVResource theResource, RequestContext context) Retrieves the value for all multi-value properties and calls the addMultiValuePropertyValue method of IMVResource. This method does not return output.
populateJoinedProperty(IMVResource theResource, String propertyName, RequestContext context) Retrieves the value for all single value properties and calls the addMultiValuePropertyValue method of IMVResource. This method does not return output.
syncJoinedProperty(IMVResource theResource, String propertyName, List values, RequestContext context) Populates the multi-value property into the resource repository.

Parent topic: Use the Personalization APIs

Method	Explanation
setMultiValueUtils(IMultiValueUtils instance)	Saves the reference to the instance of MultiValueUtils. That reference is used when invoking the fillinMultiValueProperties method of the MultiValueUtils class. This method does not return output.
addMultiValuePropertyValue(String propertyname, Object propertyvalue)	Enables the IMVResource instance to add values for multi-value properties. This method does not return output.

Method	Explanation
convertSQLtoMultiValue(String query)	Converts the SQL query string for ResourceManager3 classes that need to search on single value and multi-value properties. Returns an enumeration containing the converted where clause followed by one or more elements containing the table names that are involved in the query.
populateJoinedProperties(IMVResource theResource, RequestContext context)	Retrieves the value for all multi-value properties and calls the addMultiValuePropertyValue method of IMVResource. This method does not return output.
populateJoinedProperty(IMVResource theResource, String propertyName, RequestContext context)	Retrieves the value for all single value properties and calls the addMultiValuePropertyValue method of IMVResource. This method does not return output.
syncJoinedProperty(IMVResource theResource, String propertyName, List values, RequestContext context)	Populates the multi-value property into the resource repository.