com.liferay.portal.kernel.service

Interface PhoneLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PhoneLocalServiceWrapper

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

Provides the local service interface for Phone. 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 Also:

PhoneLocalServiceUtil, PhoneLocalServiceBaseImpl, PhoneLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Phone	addPhone(long userId, String className, long classPK, String number, String extension, long typeId, boolean primary, ServiceContext serviceContext)
Phone	addPhone(Phone phone) Adds the phone to the database.
Phone	createPhone(long phoneId) Creates a new phone with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
Phone	deletePhone(long phoneId) Deletes the phone with the primary key from the database.
Phone	deletePhone(Phone phone) Deletes the phone from the database.
void	deletePhones(long companyId, String className, long classPK)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Phone	fetchPhone(long phoneId)
Phone	fetchPhoneByUuidAndCompanyId(String uuid, long companyId) Returns the phone with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Phone	getPhone(long phoneId) Returns the phone with the primary key.
Phone	getPhoneByUuidAndCompanyId(String uuid, long companyId) Returns the phone with the matching UUID and company.
List<Phone>	getPhones()
List<Phone>	getPhones(int start, int end) Returns a range of all the phones.
List<Phone>	getPhones(long companyId, String className, long classPK)
int	getPhonesCount() Returns the number of phones.
Phone	updatePhone(long phoneId, String number, String extension, long typeId, boolean primary)
Phone	updatePhone(Phone phone) Updates the phone in the database or adds it if it does not yet exist.

Method Detail

addPhone

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

Throws:

PortalException

addPhone

@Indexable(type=REINDEX)
Phone addPhone(Phone phone)

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

Parameters:

phone - the phone

Returns:

the phone that was added

createPhone

@Transactional(enabled=false)
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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deletePhone

@Indexable(type=DELETE)
Phone deletePhone(long phoneId)
                                   throws PortalException

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

Parameters:

phoneId - the primary key of the phone

Returns:

the phone that was removed

Throws:

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

deletePhone

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
Phone deletePhone(Phone phone)

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

Parameters:

phone - the phone

Returns:

the phone that was removed

deletePhones

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(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 PhoneModelImpl. 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            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 PhoneModelImpl. 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          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

fetchPhone

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone fetchPhone(long phoneId)

fetchPhoneByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone fetchPhoneByUuidAndCompanyId(String uuid,
                                                                                                      long companyId)

Returns the phone with the matching UUID and company.

Parameters:

uuid - the phone's UUID

companyId - the primary key of the company

Returns:

the matching phone, or null if a matching phone could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getPhone

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

Returns the phone with the primary key.

Parameters:

phoneId - the primary key of the phone

Returns:

the phone

Throws:

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

getPhoneByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone getPhoneByUuidAndCompanyId(String uuid,
                                                                                                    long companyId)
                                                                                             throws PortalException

Returns the phone with the matching UUID and company.

Parameters:

uuid - the phone's UUID

companyId - the primary key of the company

Returns:

the matching phone

Throws:

PortalException - if a matching phone could not be found

getPhones

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

getPhones

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

Returns 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. 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 PhoneModelImpl. 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 phones

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

Returns:

the range of phones

getPhones

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

getPhonesCount

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

Returns the number of phones.

Returns:

the number of phones

updatePhone

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

Throws:

PortalException

updatePhone

@Indexable(type=REINDEX)
Phone updatePhone(Phone phone)

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

Parameters:

phone - the phone

Returns:

the phone that was updated