CompanyPersistence.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library 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 Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.service.persistence;

import aQute.bnd.annotation.ProviderType;

import com.liferay.portal.kernel.exception.NoSuchCompanyException;
import com.liferay.portal.kernel.model.Company;

/**
 * The persistence interface for the company service.
 *
 * <p>
 * Caching information and settings can be found in <code>portal.properties</code>
 * </p>
 *
 * @author Brian Wing Shun Chan
 * @see com.liferay.portal.service.persistence.impl.CompanyPersistenceImpl
 * @see CompanyUtil
 * @generated
 */
@ProviderType
public interface CompanyPersistence extends BasePersistence<Company> {
	/*
	 * NOTE FOR DEVELOPERS:
	 *
	 * Never modify or reference this interface directly. Always use {@link CompanyUtil} to access the company persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
	 */

	/**
	* Returns the company where webId = ? or throws a {@link NoSuchCompanyException} if it could not be found.
	*
	* @param webId the web ID
	* @return the matching company
	* @throws NoSuchCompanyException if a matching company could not be found
	*/
	public Company findByWebId(java.lang.String webId)
		throws NoSuchCompanyException;

	/**
	* Returns the company where webId = ? or returns <code>null</code> if it could not be found. Uses the finder cache.
	*
	* @param webId the web ID
	* @return the matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchByWebId(java.lang.String webId);

	/**
	* Returns the company where webId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache.
	*
	* @param webId the web ID
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchByWebId(java.lang.String webId,
		boolean retrieveFromCache);

	/**
	* Removes the company where webId = ? from the database.
	*
	* @param webId the web ID
	* @return the company that was removed
	*/
	public Company removeByWebId(java.lang.String webId)
		throws NoSuchCompanyException;

	/**
	* Returns the number of companies where webId = ?.
	*
	* @param webId the web ID
	* @return the number of matching companies
	*/
	public int countByWebId(java.lang.String webId);

	/**
	* Returns the company where mx = ? or throws a {@link NoSuchCompanyException} if it could not be found.
	*
	* @param mx the mx
	* @return the matching company
	* @throws NoSuchCompanyException if a matching company could not be found
	*/
	public Company findByMx(java.lang.String mx) throws NoSuchCompanyException;

	/**
	* Returns the company where mx = ? or returns <code>null</code> if it could not be found. Uses the finder cache.
	*
	* @param mx the mx
	* @return the matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchByMx(java.lang.String mx);

	/**
	* Returns the company where mx = ? or returns <code>null</code> if it could not be found, optionally using the finder cache.
	*
	* @param mx the mx
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchByMx(java.lang.String mx, boolean retrieveFromCache);

	/**
	* Removes the company where mx = ? from the database.
	*
	* @param mx the mx
	* @return the company that was removed
	*/
	public Company removeByMx(java.lang.String mx)
		throws NoSuchCompanyException;

	/**
	* Returns the number of companies where mx = ?.
	*
	* @param mx the mx
	* @return the number of matching companies
	*/
	public int countByMx(java.lang.String mx);

	/**
	* Returns the company where logoId = ? or throws a {@link NoSuchCompanyException} if it could not be found.
	*
	* @param logoId the logo ID
	* @return the matching company
	* @throws NoSuchCompanyException if a matching company could not be found
	*/
	public Company findByLogoId(long logoId) throws NoSuchCompanyException;

	/**
	* Returns the company where logoId = ? or returns <code>null</code> if it could not be found. Uses the finder cache.
	*
	* @param logoId the logo ID
	* @return the matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchByLogoId(long logoId);

	/**
	* Returns the company where logoId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache.
	*
	* @param logoId the logo ID
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchByLogoId(long logoId, boolean retrieveFromCache);

	/**
	* Removes the company where logoId = ? from the database.
	*
	* @param logoId the logo ID
	* @return the company that was removed
	*/
	public Company removeByLogoId(long logoId) throws NoSuchCompanyException;

	/**
	* Returns the number of companies where logoId = ?.
	*
	* @param logoId the logo ID
	* @return the number of matching companies
	*/
	public int countByLogoId(long logoId);

	/**
	* Returns all the companies where system = ?.
	*
	* @param system the system
	* @return the matching companies
	*/
	public java.util.List<Company> findBySystem(boolean system);

	/**
	* Returns a range of all the companies where system = ?.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link CompanyModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param system the system
	* @param start the lower bound of the range of companies
	* @param end the upper bound of the range of companies (not inclusive)
	* @return the range of matching companies
	*/
	public java.util.List<Company> findBySystem(boolean system, int start,
		int end);

	/**
	* Returns an ordered range of all the companies where system = ?.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link CompanyModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param system the system
	* @param start the lower bound of the range of companies
	* @param end the upper bound of the range of companies (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @return the ordered range of matching companies
	*/
	public java.util.List<Company> findBySystem(boolean system, int start,
		int end,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator);

	/**
	* Returns an ordered range of all the companies where system = ?.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link CompanyModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param system the system
	* @param start the lower bound of the range of companies
	* @param end the upper bound of the range of companies (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the ordered range of matching companies
	*/
	public java.util.List<Company> findBySystem(boolean system, int start,
		int end,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator,
		boolean retrieveFromCache);

	/**
	* Returns the first company in the ordered set where system = ?.
	*
	* @param system the system
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the first matching company
	* @throws NoSuchCompanyException if a matching company could not be found
	*/
	public Company findBySystem_First(boolean system,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator)
		throws NoSuchCompanyException;

	/**
	* Returns the first company in the ordered set where system = ?.
	*
	* @param system the system
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the first matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchBySystem_First(boolean system,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator);

	/**
	* Returns the last company in the ordered set where system = ?.
	*
	* @param system the system
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the last matching company
	* @throws NoSuchCompanyException if a matching company could not be found
	*/
	public Company findBySystem_Last(boolean system,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator)
		throws NoSuchCompanyException;

	/**
	* Returns the last company in the ordered set where system = ?.
	*
	* @param system the system
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the last matching company, or <code>null</code> if a matching company could not be found
	*/
	public Company fetchBySystem_Last(boolean system,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator);

	/**
	* Returns the companies before and after the current company in the ordered set where system = ?.
	*
	* @param companyId the primary key of the current company
	* @param system the system
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the previous, current, and next company
	* @throws NoSuchCompanyException if a company with the primary key could not be found
	*/
	public Company[] findBySystem_PrevAndNext(long companyId, boolean system,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator)
		throws NoSuchCompanyException;

	/**
	* Removes all the companies where system = ? from the database.
	*
	* @param system the system
	*/
	public void removeBySystem(boolean system);

	/**
	* Returns the number of companies where system = ?.
	*
	* @param system the system
	* @return the number of matching companies
	*/
	public int countBySystem(boolean system);

	/**
	* Caches the company in the entity cache if it is enabled.
	*
	* @param company the company
	*/
	public void cacheResult(Company company);

	/**
	* Caches the companies in the entity cache if it is enabled.
	*
	* @param companies the companies
	*/
	public void cacheResult(java.util.List<Company> companies);

	/**
	* Creates a new company with the primary key. Does not add the company to the database.
	*
	* @param companyId the primary key for the new company
	* @return the new company
	*/
	public Company create(long companyId);

	/**
	* Removes the company with the primary key from the database. Also notifies the appropriate model listeners.
	*
	* @param companyId the primary key of the company
	* @return the company that was removed
	* @throws NoSuchCompanyException if a company with the primary key could not be found
	*/
	public Company remove(long companyId) throws NoSuchCompanyException;

	public Company updateImpl(Company company);

	/**
	* Returns the company with the primary key or throws a {@link NoSuchCompanyException} if it could not be found.
	*
	* @param companyId the primary key of the company
	* @return the company
	* @throws NoSuchCompanyException if a company with the primary key could not be found
	*/
	public Company findByPrimaryKey(long companyId)
		throws NoSuchCompanyException;

	/**
	* Returns the company with the primary key or returns <code>null</code> if it could not be found.
	*
	* @param companyId the primary key of the company
	* @return the company, or <code>null</code> if a company with the primary key could not be found
	*/
	public Company fetchByPrimaryKey(long companyId);

	@Override
	public java.util.Map<java.io.Serializable, Company> fetchByPrimaryKeys(
		java.util.Set<java.io.Serializable> primaryKeys);

	/**
	* Returns all the companies.
	*
	* @return the companies
	*/
	public java.util.List<Company> findAll();

	/**
	* Returns a range of all the companies.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link CompanyModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param start the lower bound of the range of companies
	* @param end the upper bound of the range of companies (not inclusive)
	* @return the range of companies
	*/
	public java.util.List<Company> findAll(int start, int end);

	/**
	* Returns an ordered range of all the companies.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link CompanyModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param start the lower bound of the range of companies
	* @param end the upper bound of the range of companies (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @return the ordered range of companies
	*/
	public java.util.List<Company> findAll(int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator);

	/**
	* Returns an ordered range of all the companies.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link CompanyModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param start the lower bound of the range of companies
	* @param end the upper bound of the range of companies (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the ordered range of companies
	*/
	public java.util.List<Company> findAll(int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator<Company> orderByComparator,
		boolean retrieveFromCache);

	/**
	* Removes all the companies from the database.
	*/
	public void removeAll();

	/**
	* Returns the number of companies.
	*
	* @return the number of companies
	*/
	public int countAll();

	@Override
	public java.util.Set<java.lang.String> getBadColumnNames();
}