com.liferay.portal.service
Interface PhoneLocalService

All Known Implementing Classes:

PhoneLocalServiceBaseImpl, PhoneLocalServiceImpl, PhoneLocalServiceWrapper

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

The interface for the phone local service.

Never modify or reference this interface directly. Always use PhoneLocalServiceUtil to access the phone local service. Add custom service methods to PhoneLocalServiceImpl 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:

PhoneLocalServiceUtil, PhoneLocalServiceBaseImpl, PhoneLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Phone	addPhone(long userId, String className, long classPK, String number, String extension, int typeId, boolean primary)
Phone	addPhone(Phone phone) Adds the phone to the database.
Phone	createPhone(long phoneId) Creates a new phone with the primary key.
void	deletePhone(long phoneId) Deletes the phone with the primary key from the database.
void	deletePhone(Phone phone) Deletes the phone from the database.
void	deletePhones(long companyId, String className, long classPK)
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.
Phone	getPhone(long phoneId) Gets the phone with the primary key.
List<Phone>	getPhones()
List<Phone>	getPhones(int start, int end) Gets a range of all the phones.
List<Phone>	getPhones(long companyId, String className, long classPK)
int	getPhonesCount() Gets the number of phones.
Phone	updatePhone(long phoneId, String number, String extension, int typeId, boolean primary)
Phone	updatePhone(Phone phone) Updates the phone in the database.
Phone	updatePhone(Phone phone, boolean merge) Updates the phone in the database.

Method Detail

addPhone

Phone addPhone(Phone phone)
               throws SystemException

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

Parameters:

phone - the phone to add

Returns:

the phone that was added

Throws:

SystemException - if a system exception occurred

createPhone

Phone createPhone(long phoneId)

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

Parameters:

phoneId - the primary key for the new phone

Returns:

the new phone

deletePhone

void deletePhone(long phoneId)
                 throws PortalException,
                        SystemException

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

Parameters:

phoneId - the primary key of the phone to delete

Throws:

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

SystemException - if a system exception occurred

deletePhone

void deletePhone(Phone phone)
                 throws SystemException

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

Parameters:

phone - the phone 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

getPhone

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone getPhone(long phoneId)
               throws PortalException,
                      SystemException

Gets the phone with the primary key.

Parameters:

phoneId - the primary key of the phone to get

Returns:

the phone

Throws:

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

SystemException - if a system exception occurred

getPhones

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Phone> getPhones(int start,
                                                               int end)
                      throws SystemException

Gets a range of all the phones.

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 phones to return

end - the upper bound of the range of phones to return (not inclusive)

Returns:

the range of phones

Throws:

SystemException - if a system exception occurred

getPhonesCount

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

Gets the number of phones.

Returns:

the number of phones

Throws:

SystemException - if a system exception occurred

updatePhone

Phone updatePhone(Phone phone)
                  throws SystemException

Updates the phone in the database. Also notifies the appropriate model listeners.

Parameters:

phone - the phone to update

Returns:

the phone that was updated

Throws:

SystemException - if a system exception occurred

updatePhone

Phone updatePhone(Phone phone,
                  boolean merge)
                  throws SystemException

Updates the phone in the database. Also notifies the appropriate model listeners.

Parameters:

phone - the phone to update

merge - whether to merge the phone 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 phone that was updated

Throws:

SystemException - if a system exception occurred

addPhone

Phone addPhone(long userId,
               String className,
               long classPK,
               String number,
               String extension,
               int typeId,
               boolean primary)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

deletePhones

void deletePhones(long companyId,
                  String className,
                  long classPK)
                  throws SystemException

Throws:

SystemException

getPhones

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Phone> getPhones()
                      throws SystemException

Throws:

SystemException

getPhones

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Phone> getPhones(long companyId,
                                                               String className,
                                                               long classPK)
                      throws SystemException

Throws:

SystemException

updatePhone

Phone updatePhone(long phoneId,
                  String number,
                  String extension,
                  int typeId,
                  boolean primary)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException