com.liferay.portal.service.persistence.ContactPersistence Maven / Gradle / Ivy
Show all versions of portal-service Show documentation
/**
* 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 com.liferay.portal.model.Contact;
/**
* The persistence interface for the contact service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see ContactPersistenceImpl
* @see ContactUtil
* @generated
*/
public interface ContactPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link ContactUtil} to access the contact persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the contacts where companyId = ?.
*
* @param companyId the company ID
* @return the matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByCompanyId(
long companyId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the contacts where companyId = ?.
*
*
* 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.ContactModelImpl}. 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 companyId the company ID
* @param start the lower bound of the range of contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @return the range of matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByCompanyId(
long companyId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the contacts where companyId = ?.
*
*
* 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.ContactModelImpl}. 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 companyId the company ID
* @param start the lower bound of the range of contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByCompanyId(
long companyId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first contact in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching contact
* @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByCompanyId_First(
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first contact in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching contact, or null if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByCompanyId_First(
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last contact in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching contact
* @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByCompanyId_Last(
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last contact in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching contact, or null if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByCompanyId_Last(
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the contacts before and after the current contact in the ordered set where companyId = ?.
*
* @param contactId the primary key of the current contact
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next contact
* @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact[] findByCompanyId_PrevAndNext(
long contactId, long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the contacts where companyId = ? from the database.
*
* @param companyId the company ID
* @throws SystemException if a system exception occurred
*/
public void removeByCompanyId(long companyId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of contacts where companyId = ?.
*
* @param companyId the company ID
* @return the number of matching contacts
* @throws SystemException if a system exception occurred
*/
public int countByCompanyId(long companyId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the contacts where accountId = ?.
*
* @param accountId the account ID
* @return the matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByAccountId(
long accountId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the contacts where accountId = ?.
*
*
* 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.ContactModelImpl}. 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 accountId the account ID
* @param start the lower bound of the range of contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @return the range of matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByAccountId(
long accountId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the contacts where accountId = ?.
*
*
* 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.ContactModelImpl}. 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 accountId the account ID
* @param start the lower bound of the range of contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByAccountId(
long accountId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first contact in the ordered set where accountId = ?.
*
* @param accountId the account ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching contact
* @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByAccountId_First(
long accountId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first contact in the ordered set where accountId = ?.
*
* @param accountId the account ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching contact, or null if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByAccountId_First(
long accountId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last contact in the ordered set where accountId = ?.
*
* @param accountId the account ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching contact
* @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByAccountId_Last(
long accountId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last contact in the ordered set where accountId = ?.
*
* @param accountId the account ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching contact, or null if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByAccountId_Last(
long accountId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the contacts before and after the current contact in the ordered set where accountId = ?.
*
* @param contactId the primary key of the current contact
* @param accountId the account ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next contact
* @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact[] findByAccountId_PrevAndNext(
long contactId, long accountId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the contacts where accountId = ? from the database.
*
* @param accountId the account ID
* @throws SystemException if a system exception occurred
*/
public void removeByAccountId(long accountId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of contacts where accountId = ?.
*
* @param accountId the account ID
* @return the number of matching contacts
* @throws SystemException if a system exception occurred
*/
public int countByAccountId(long accountId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the contacts where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @return the matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByC_C(
long classNameId, long classPK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the contacts where classNameId = ? and classPK = ?.
*
*
* 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.ContactModelImpl}. 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 classNameId the class name ID
* @param classPK the class p k
* @param start the lower bound of the range of contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @return the range of matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByC_C(
long classNameId, long classPK, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the contacts where classNameId = ? and classPK = ?.
*
*
* 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.ContactModelImpl}. 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 classNameId the class name ID
* @param classPK the class p k
* @param start the lower bound of the range of contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching contacts
* @throws SystemException if a system exception occurred
*/
public java.util.List findByC_C(
long classNameId, long classPK, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first contact in the ordered set where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching contact
* @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByC_C_First(long classNameId,
long classPK,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first contact in the ordered set where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching contact, or null if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByC_C_First(long classNameId,
long classPK,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last contact in the ordered set where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching contact
* @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByC_C_Last(long classNameId,
long classPK,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last contact in the ordered set where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching contact, or null if a matching contact could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByC_C_Last(long classNameId,
long classPK,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the contacts before and after the current contact in the ordered set where classNameId = ? and classPK = ?.
*
* @param contactId the primary key of the current contact
* @param classNameId the class name ID
* @param classPK the class p k
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next contact
* @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact[] findByC_C_PrevAndNext(
long contactId, long classNameId, long classPK,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the contacts where classNameId = ? and classPK = ? from the database.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @throws SystemException if a system exception occurred
*/
public void removeByC_C(long classNameId, long classPK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of contacts where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @return the number of matching contacts
* @throws SystemException if a system exception occurred
*/
public int countByC_C(long classNameId, long classPK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the contact in the entity cache if it is enabled.
*
* @param contact the contact
*/
public void cacheResult(com.liferay.portal.model.Contact contact);
/**
* Caches the contacts in the entity cache if it is enabled.
*
* @param contacts the contacts
*/
public void cacheResult(
java.util.List contacts);
/**
* Creates a new contact with the primary key. Does not add the contact to the database.
*
* @param contactId the primary key for the new contact
* @return the new contact
*/
public com.liferay.portal.model.Contact create(long contactId);
/**
* Removes the contact with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param contactId the primary key of the contact
* @return the contact that was removed
* @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact remove(long contactId)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Contact updateImpl(
com.liferay.portal.model.Contact contact)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the contact with the primary key or throws a {@link com.liferay.portal.NoSuchContactException} if it could not be found.
*
* @param contactId the primary key of the contact
* @return the contact
* @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact findByPrimaryKey(long contactId)
throws com.liferay.portal.NoSuchContactException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the contact with the primary key or returns null if it could not be found.
*
* @param contactId the primary key of the contact
* @return the contact, or null if a contact with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Contact fetchByPrimaryKey(long contactId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the contacts.
*
* @return the contacts
* @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 contacts.
*
*
* 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.ContactModelImpl}. 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 contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @return the range of contacts
* @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 contacts.
*
*
* 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.ContactModelImpl}. 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 contacts
* @param end the upper bound of the range of contacts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of contacts
* @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 contacts from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of contacts.
*
* @return the number of contacts
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}