UserMetadataBiz.java

/* ==================================================================
 * UserMetadataBiz.java - 11/11/2016 11:18:00 AM
 * 
 * Copyright 2007-2016 SolarNetwork.net Dev Team
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.central.user.biz;

import java.util.List;
import net.solarnetwork.central.domain.FilterResults;
import net.solarnetwork.central.domain.SortDescriptor;
import net.solarnetwork.central.user.domain.UserMetadataFilter;
import net.solarnetwork.central.user.domain.UserMetadataFilterMatch;
import net.solarnetwork.domain.GeneralDatumMetadata;

/**
 * API for manipulating user metadata.
 * 
 * @author matt
 * @version 1.0
 * @since 1.23
 */
public interface UserMetadataBiz {

	/**
	 * Add metadata to a specific user. If metadata already exists for the given
	 * user, the values will be merged such that tags are added and info values
	 * are added or updated.
	 * 
	 * @param userId
	 *        the user ID to add to
	 * @param meta
	 *        the metadata to add
	 */
	void addUserMetadata(Long userId, GeneralDatumMetadata meta);

	/**
	 * Store metadata to a specific user, replacing any existing metadata with
	 * the provided metadata.
	 * 
	 * @param userId
	 *        the user ID to add to
	 * @param meta
	 *        the metadata to store
	 */
	void storeUserMetadata(Long userId, GeneralDatumMetadata meta);

	/**
	 * Remove all metadata to a specific user.
	 * 
	 * @param userId
	 *        the user ID to remove from
	 */
	void removeUserMetadata(Long userId);

	/**
	 * Search for user metadata.
	 * 
	 * @param criteria
	 *        the search criteria
	 * @param sortDescriptors
	 *        the optional sort descriptors
	 * @param offset
	 *        an optional result offset
	 * @param max
	 *        an optional maximum number of returned results
	 * @return the results, never <em>null</em>
	 */
	FilterResults<UserMetadataFilterMatch> findUserMetadata(UserMetadataFilter criteria,
			List<SortDescriptor> sortDescriptors, Integer offset, Integer max);

}