com.liferay.portal.service
Interface ContactLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ContactLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ContactLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the contact local service.

This is a local service. 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:

ContactLocalServiceUtil, ContactLocalServiceBaseImpl, com.liferay.portal.service.impl.ContactLocalServiceImpl

Method Summary

Contact	addContact(Contact contact) Adds the contact to the database.
Contact	createContact(long contactId) Creates a new contact with the primary key.
Contact	deleteContact(Contact contact) Deletes the contact from the database.
Contact	deleteContact(long contactId) Deletes the contact with the primary key from the database.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
Contact	fetchContact(long contactId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
Contact	getContact(long contactId) Returns the contact with the primary key.
List<Contact>	getContacts(int start, int end) Returns a range of all the contacts.
int	getContactsCount() Returns the number of contacts.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
Contact	updateContact(Contact contact) Updates the contact in the database or adds it if it does not yet exist.
Contact	updateContact(Contact contact, boolean merge) Updates the contact in the database or adds it if it does not yet exist.

Method Detail

addContact

Contact addContact(Contact contact)
                   throws SystemException

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

Parameters:

contact - the contact

Returns:

the contact that was added

Throws:

SystemException - if a system exception occurred

createContact

Contact createContact(long contactId)

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

Parameters:

contactId - the primary key for the new contact

Returns:

the new contact

deleteContact

Contact deleteContact(long contactId)
                      throws PortalException,
                             SystemException

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

Parameters:

contactId - the primary key of the contact

Returns:

the contact that was removed

Throws:

PortalException - if a contact with the primary key could not be found

SystemException - if a system exception occurred

deleteContact

Contact deleteContact(Contact contact)
                      throws SystemException

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

Parameters:

contact - the contact

Returns:

the contact that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchContact

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Contact fetchContact(long contactId)
                     throws SystemException

Throws:

SystemException

getContact

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Contact getContact(long contactId)
                   throws PortalException,
                          SystemException

Returns the contact with the primary key.

Parameters:

contactId - the primary key of the contact

Returns:

the contact

Throws:

PortalException - if a contact with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getContacts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Contact> getContacts(int start,
                                                                   int end)
                          throws 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 QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of contacts

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

Returns:

the range of contacts

Throws:

SystemException - if a system exception occurred

getContactsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getContactsCount()
                     throws SystemException

Returns the number of contacts.

Returns:

the number of contacts

Throws:

SystemException - if a system exception occurred

updateContact

Contact updateContact(Contact contact)
                      throws SystemException

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

Parameters:

contact - the contact

Returns:

the contact that was updated

Throws:

SystemException - if a system exception occurred

updateContact

Contact updateContact(Contact contact,
                      boolean merge)
                      throws SystemException

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

Parameters:

contact - the contact

merge - whether to merge the contact with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the contact that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean