com.ocs.dynamo.ui.composite.layout.SimpleSearchLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamo-frontend Show documentation
The newest version!
/*
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package com.ocs.dynamo.ui.composite.layout;

import java.io.Serializable;
import java.util.List;

import com.ocs.dynamo.constants.DynamoConstants;
import com.ocs.dynamo.dao.FetchJoinInformation;
import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.EntityModel;
import com.ocs.dynamo.service.BaseService;
import com.ocs.dynamo.ui.composite.form.ModelBasedSearchForm;
import com.ocs.dynamo.ui.provider.QueryType;
import com.vaadin.flow.data.provider.SortOrder;

/**
 * A composite component that contains a search form and a results grid, along
 * with the option to navigate to a detail screen for adding/editing
 * 
 * @author bas.rutten
 * @param  type of the primary key of the entity to search for
 * @param   type of the entity to search for
 */
public class SimpleSearchLayout>
		extends AbstractModelSearchLayout {

	private static final long serialVersionUID = 4606800218149558500L;

	/**
	 * Constructor - only the most important attributes
	 * 
	 * @param service     the service that is used to query the database
	 * @param entityModel the entity model of the entities to search for
	 * @param queryType   the type of the query
	 * @param formOptions form options that governs which buttons and options to
	 *                    show
	 * @param sortOrder   the default sort order
	 * @param joins       the joins to include in the query
	 */
	public SimpleSearchLayout(BaseService service, EntityModel entityModel, QueryType queryType,
			FormOptions formOptions, SortOrder sortOrder, FetchJoinInformation... joins) {
		super(service, entityModel, queryType, formOptions, sortOrder, joins);
		addClassName(DynamoConstants.CSS_SIMPLE_SEARCH_LAYOUT);
	}

	/**
	 * Constructs the search form
	 * 
	 * @return the search form
	 */
	@Override
	protected ModelBasedSearchForm constructSearchForm() {
		ModelBasedSearchForm searchForm = new ModelBasedSearchForm(null, getEntityModel(),
				getFormOptions(), getComponentContext(), getDefaultFilters(), getFieldFilters());

		initSearchForm(searchForm);
		searchForm.build();
		return searchForm;
	}

	@Override
	public ModelBasedSearchForm getSearchForm() {
		return (ModelBasedSearchForm) super.getSearchForm();
	}

	public void setSearchColumnThresholds(List searchColumnThresholds) {
		getComponentContext().setSearchColumnThresholds(searchColumnThresholds);
	}

	public void setMaxSearchFormWidth(String maxSearchFormWidth) {
		getComponentContext().setMaxSearchFormWidth(maxSearchFormWidth);
	}

	/**
	 * Sets a certain search value (for a property with a single value to search on)
	 * 
	 * @param propertyId the property to search for
	 * @param value      the desired value
	 */
	@Override
	public void setSearchValue(String propertyId, Object value) {
		getSearchForm().setSearchValue(propertyId, value);
	}

	/**
	 * Sets a certain search value (for a property with an upper and a lower bound)
	 * 
	 * @param propertyId the property to search for
	 * @param value      the value of the lower bound
	 * @param auxValue   the value of the upper bound
	 */
	@Override
	public void setSearchValue(String propertyId, Object value, Object auxValue) {
		getSearchForm().setSearchValue(propertyId, value, auxValue);
	}

}