com.liferay.contacts.service

Interface EntryLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

EntryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface EntryLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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.

See Also:

EntryLocalServiceUtil, com.liferay.contacts.service.base.EntryLocalServiceBaseImpl, com.liferay.contacts.service.impl.EntryLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
Entry	addEntry(Entry entry) Adds the entry to the database.
Entry	addEntry(long userId, java.lang.String fullName, java.lang.String emailAddress, java.lang.String comments)
Entry	createEntry(long entryId) Creates a new entry with the primary key.
Entry	deleteEntry(Entry entry) Deletes the entry from the database.
Entry	deleteEntry(long entryId) Deletes the entry with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
Entry	fetchEntry(long entryId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<Entry>	getEntries(int start, int end) Returns a range of all the entries.
java.util.List<Entry>	getEntries(long userId, int start, int end)
int	getEntriesCount() Returns the number of entries.
int	getEntriesCount(long userId)
Entry	getEntry(long entryId) Returns the entry with the primary key.
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<Entry>	search(long userId, java.lang.String keywords, int start, int end)
int	searchCount(long userId, java.lang.String keywords)
java.util.List<com.liferay.portal.kernel.model.BaseModel<?>>	searchUsersAndContacts(long companyId, long userId, java.lang.String keywords, int start, int end)
int	searchUsersAndContactsCount(long companyId, long userId, java.lang.String keywords)
Entry	updateEntry(Entry entry) Updates the entry in the database or adds it if it does not yet exist.
Entry	updateEntry(long entryId, java.lang.String fullName, java.lang.String emailAddress, java.lang.String comments)

Method Detail

addEntry

@Indexable(type=REINDEX)
Entry addEntry(Entry entry)

Adds the entry to the database. Also notifies the appropriate model listeners.

Parameters:

entry - the entry

Returns:

the entry that was added

addEntry

Entry addEntry(long userId,
               java.lang.String fullName,
               java.lang.String emailAddress,
               java.lang.String comments)
        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createEntry

@Transactional(enabled=false)
Entry createEntry(long entryId)

Creates a new entry with the primary key. Does not add the entry to the database.

Parameters:

entryId - the primary key for the new entry

Returns:

the new entry

deleteEntry

@Indexable(type=DELETE)
Entry deleteEntry(Entry entry)

Deletes the entry from the database. Also notifies the appropriate model listeners.

Parameters:

entry - the entry

Returns:

the entry that was removed

deleteEntry

@Indexable(type=DELETE)
Entry deleteEntry(long entryId)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deletes the entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

entryId - the primary key of the entry

Returns:

the entry that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a entry with the primary key could not be found

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end)

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.contacts.model.impl.EntryModelImpl. 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.contacts.model.impl.EntryModelImpl. 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                       com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Entry fetchEntry(long entryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Entry> getEntries(int start,
                                                                                                    int end)

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.contacts.model.impl.EntryModelImpl. 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.

Parameters:

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

Returns:

the range of entries

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Entry> getEntries(long userId,
                                                                                                    int start,
                                                                                                    int end)

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount()

Returns the number of entries.

Returns:

the number of entries

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId)

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Entry getEntry(long entryId)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Returns the entry with the primary key.

Parameters:

entryId - the primary key of the entry

Returns:

the entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a entry with the primary key could not be found

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Entry> search(long userId,
                                                                                                java.lang.String keywords,
                                                                                                int start,
                                                                                                int end)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long userId,
                                                                                   java.lang.String keywords)

searchUsersAndContacts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<com.liferay.portal.kernel.model.BaseModel<?>> searchUsersAndContacts(long companyId,
                                                                                                                                                       long userId,
                                                                                                                                                       java.lang.String keywords,
                                                                                                                                                       int start,
                                                                                                                                                       int end)

searchUsersAndContactsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchUsersAndContactsCount(long companyId,
                                                                                                   long userId,
                                                                                                   java.lang.String keywords)

updateEntry

@Indexable(type=REINDEX)
Entry updateEntry(Entry entry)

Updates the entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

entry - the entry

Returns:

the entry that was updated

updateEntry

Entry updateEntry(long entryId,
                  java.lang.String fullName,
                  java.lang.String emailAddress,
                  java.lang.String comments)
           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException