Liferay 6.0.5

com.liferay.portal.service
Interface ContactLocalService

All Known Implementing Classes:
ContactLocalServiceBaseImpl, ContactLocalServiceImpl, ContactLocalServiceWrapper

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

The interface for the contact local service.

Never modify or reference this interface directly. Always use ContactLocalServiceUtil to access the contact local service. Add custom service methods to ContactLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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, ContactLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Contact addContact(Contact contact)
          Adds the contact to the database.
 Contact createContact(long contactId)
          Creates a new contact with the primary key.
 void deleteContact(Contact contact)
          Deletes the contact from the database.
 void deleteContact(long contactId)
          Deletes the contact with the primary key from the database.
 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)
          Counts the number of rows that match the dynamic query.
 Contact getContact(long contactId)
          Gets the contact with the primary key.
 List<Contact> getContacts(int start, int end)
          Gets a range of all the contacts.
 int getContactsCount()
          Gets the number of contacts.
 Contact updateContact(Contact contact)
          Updates the contact in the database.
 Contact updateContact(Contact contact, boolean merge)
          Updates the contact in the database.
 

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 to add
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

void 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 to delete
Throws:
PortalException - if a contact with the primary key could not be found
SystemException - if a system exception occurred

deleteContact

void deleteContact(Contact contact)
                   throws SystemException
Deletes the contact from the database. Also notifies the appropriate model listeners.

Parameters:
contact - the contact to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getContact

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Contact getContact(long contactId)
                   throws PortalException,
                          SystemException
Gets the contact with the primary key.

Parameters:
contactId - the primary key of the contact to get
Returns:
the contact
Throws:
PortalException - if a contact with the primary key could not be found
SystemException - if a system exception occurred

getContacts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Contact> getContacts(int start,
                                                                   int end)
                          throws SystemException
Gets 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 to return
end - the upper bound of the range of contacts to return (not inclusive)
Returns:
the range of contacts
Throws:
SystemException - if a system exception occurred

getContactsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getContactsCount()
                     throws SystemException
Gets 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. Also notifies the appropriate model listeners.

Parameters:
contact - the contact to update
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. Also notifies the appropriate model listeners.

Parameters:
contact - the contact to update
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

Liferay 6.0.5