com.liferay.contacts.service.EntryLocalService Maven / Gradle / Ivy
/**
* 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.contacts.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.contacts.model.Entry;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.BaseModel;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for Entry. Methods of this
* service will not have security checks based on the propagated JAAS
* credentials because this service can only be accessed from within the same
* VM.
*
* @author Brian Wing Shun Chan
* @see EntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface EntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.contacts.service.impl.EntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the entry local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link EntryLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the entry to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param entry the entry
* @return the entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public Entry addEntry(Entry entry);
public Entry addEntry(
long userId, String fullName, String emailAddress, String comments)
throws PortalException;
/**
* Creates a new entry with the primary key. Does not add the entry to the database.
*
* @param entryId the primary key for the new entry
* @return the new entry
*/
@Transactional(enabled = false)
public Entry createEntry(long entryId);
/**
* Deletes the entry from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param entry the entry
* @return the entry that was removed
*/
@Indexable(type = IndexableType.DELETE)
public Entry deleteEntry(Entry entry);
/**
* Deletes the entry with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param entryId the primary key of the entry
* @return the entry that was removed
* @throws PortalException if a entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public Entry deleteEntry(long entryId) throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery dynamicQuery);
/**
* Performs a dynamic query on the database and returns a range of the matching rows.
*
*
* 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 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, then the query will include the default ORDER BY logic from com.liferay.contacts.model.impl.EntryModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* Performs a dynamic query on the database and returns an ordered range of the matching rows.
*
*
* 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 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, then the query will include the default ORDER BY logic from com.liferay.contacts.model.impl.EntryModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Entry fetchEntry(long entryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns a range of all the entries.
*
*
* 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 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, then the query will include the default ORDER BY logic from com.liferay.contacts.model.impl.EntryModelImpl.
*
*
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (not inclusive)
* @return the range of entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getEntries(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getEntries(long userId, int start, int end);
/**
* Returns the number of entries.
*
* @return the number of entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getEntriesCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getEntriesCount(long userId);
/**
* Returns the entry with the primary key.
*
* @param entryId the primary key of the entry
* @return the entry
* @throws PortalException if a entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Entry getEntry(long entryId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(long userId, String keywords, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(long userId, String keywords);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List> searchUsersAndContacts(
long companyId, long userId, String keywords, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchUsersAndContactsCount(
long companyId, long userId, String keywords);
/**
* Updates the entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param entry the entry
* @return the entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public Entry updateEntry(Entry entry);
public Entry updateEntry(
long entryId, String fullName, String emailAddress, String comments)
throws PortalException;
}