com.liferay.portal.service.persistence.CompanyPersistence Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 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.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.model.Company;
/**
* The persistence interface for the company service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see CompanyPersistenceImpl
* @see CompanyUtil
* @generated
*/
@ProviderType
public interface CompanyPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link CompanyUtil} to access the company persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns the company where webId = ? or throws a {@link com.liferay.portal.NoSuchCompanyException} if it could not be found.
*
* @param webId the web ID
* @return the matching company
* @throws com.liferay.portal.NoSuchCompanyException if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company findByWebId(java.lang.String webId)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where webId = ? or returns null if it could not be found. Uses the finder cache.
*
* @param webId the web ID
* @return the matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByWebId(java.lang.String webId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where webId = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param webId the web ID
* @param retrieveFromCache whether to use the finder cache
* @return the matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByWebId(
java.lang.String webId, boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the company where webId = ? from the database.
*
* @param webId the web ID
* @return the company that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company removeByWebId(
java.lang.String webId)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of companies where webId = ?.
*
* @param webId the web ID
* @return the number of matching companies
* @throws SystemException if a system exception occurred
*/
public int countByWebId(java.lang.String webId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where mx = ? or throws a {@link com.liferay.portal.NoSuchCompanyException} if it could not be found.
*
* @param mx the mx
* @return the matching company
* @throws com.liferay.portal.NoSuchCompanyException if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company findByMx(java.lang.String mx)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where mx = ? or returns null if it could not be found. Uses the finder cache.
*
* @param mx the mx
* @return the matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByMx(java.lang.String mx)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where mx = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param mx the mx
* @param retrieveFromCache whether to use the finder cache
* @return the matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByMx(java.lang.String mx,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the company where mx = ? from the database.
*
* @param mx the mx
* @return the company that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company removeByMx(java.lang.String mx)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of companies where mx = ?.
*
* @param mx the mx
* @return the number of matching companies
* @throws SystemException if a system exception occurred
*/
public int countByMx(java.lang.String mx)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where logoId = ? or throws a {@link com.liferay.portal.NoSuchCompanyException} if it could not be found.
*
* @param logoId the logo ID
* @return the matching company
* @throws com.liferay.portal.NoSuchCompanyException if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company findByLogoId(long logoId)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where logoId = ? or returns null if it could not be found. Uses the finder cache.
*
* @param logoId the logo ID
* @return the matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByLogoId(long logoId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company where logoId = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param logoId the logo ID
* @param retrieveFromCache whether to use the finder cache
* @return the matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByLogoId(long logoId,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the company where logoId = ? from the database.
*
* @param logoId the logo ID
* @return the company that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company removeByLogoId(long logoId)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of companies where logoId = ?.
*
* @param logoId the logo ID
* @return the number of matching companies
* @throws SystemException if a system exception occurred
*/
public int countByLogoId(long logoId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the companies where system = ?.
*
* @param system the system
* @return the matching companies
* @throws SystemException if a system exception occurred
*/
public java.util.List findBySystem(
boolean system)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the companies where system = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.CompanyModelImpl}. If both orderByComparator 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.
*
*
* @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
* @throws SystemException if a system exception occurred
*/
public java.util.List findBySystem(
boolean system, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the companies where system = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.CompanyModelImpl}. If both orderByComparator 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.
*
*
* @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 null)
* @return the ordered range of matching companies
* @throws SystemException if a system exception occurred
*/
public java.util.List findBySystem(
boolean system, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first company in the ordered set where system = ?.
*
* @param system the system
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching company
* @throws com.liferay.portal.NoSuchCompanyException if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company findBySystem_First(boolean system,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first company in the ordered set where system = ?.
*
* @param system the system
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchBySystem_First(
boolean system,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last company in the ordered set where system = ?.
*
* @param system the system
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching company
* @throws com.liferay.portal.NoSuchCompanyException if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company findBySystem_Last(boolean system,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last company in the ordered set where system = ?.
*
* @param system the system
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching company, or null if a matching company could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchBySystem_Last(boolean system,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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 null)
* @return the previous, current, and next company
* @throws com.liferay.portal.NoSuchCompanyException if a company with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company[] findBySystem_PrevAndNext(
long companyId, boolean system,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the companies where system = ? from the database.
*
* @param system the system
* @throws SystemException if a system exception occurred
*/
public void removeBySystem(boolean system)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of companies where system = ?.
*
* @param system the system
* @return the number of matching companies
* @throws SystemException if a system exception occurred
*/
public int countBySystem(boolean system)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the company in the entity cache if it is enabled.
*
* @param company the company
*/
public void cacheResult(com.liferay.portal.model.Company company);
/**
* Caches the companies in the entity cache if it is enabled.
*
* @param companies the companies
*/
public void cacheResult(
java.util.List 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 com.liferay.portal.model.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 com.liferay.portal.NoSuchCompanyException if a company with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company remove(long companyId)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Company updateImpl(
com.liferay.portal.model.Company company)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company with the primary key or throws a {@link com.liferay.portal.NoSuchCompanyException} if it could not be found.
*
* @param companyId the primary key of the company
* @return the company
* @throws com.liferay.portal.NoSuchCompanyException if a company with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company findByPrimaryKey(long companyId)
throws com.liferay.portal.NoSuchCompanyException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the company with the primary key or returns null if it could not be found.
*
* @param companyId the primary key of the company
* @return the company, or null if a company with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Company fetchByPrimaryKey(long companyId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the companies.
*
* @return the companies
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the companies.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.CompanyModelImpl}. If both orderByComparator 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.
*
*
* @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
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(int start,
int end) throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the companies.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.CompanyModelImpl}. If both orderByComparator 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.
*
*
* @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 null)
* @return the ordered range of companies
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the companies from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of companies.
*
* @return the number of companies
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}