com.liferay.portal.kernel.service

Class PhoneLocalServiceUtil

Object

com.liferay.portal.kernel.service.PhoneLocalServiceUtil

public class PhoneLocalServiceUtil
extends Object

Provides the local service utility for Phone. This utility wraps com.liferay.portal.service.impl.PhoneLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:

PhoneLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
PhoneLocalServiceUtil()

Method Summary

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PhoneLocalServiceUtil

public PhoneLocalServiceUtil()

Method Detail

addPhone

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

Throws:

PortalException

addPhone

public static Phone addPhone(Phone phone)

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

Important: Inspect PhoneLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

phone - the phone

Returns:

the phone that was added

createPersistedModel

public static PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

createPhone

public static 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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deletePhone

public static Phone deletePhone(long phoneId)
                         throws PortalException

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

Important: Inspect PhoneLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

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

public static Phone deletePhone(Phone phone)

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

Important: Inspect PhoneLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

phone - the phone

Returns:

the phone that was removed

deletePhones

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

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PhoneModelImpl.

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

public static <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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PhoneModelImpl.

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

public static 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

public static 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

public static Phone fetchPhone(long phoneId)

fetchPhoneByUuidAndCompanyId

public static 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

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getPhone

public static 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

public static 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

public static List<Phone> getPhones()

getPhones

public static 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PhoneModelImpl.

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

public static List<Phone> getPhones(long companyId,
                                    String className,
                                    long classPK)

getPhonesCount

public static int getPhonesCount()

Returns the number of phones.

Returns:

the number of phones

updatePhone

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

Throws:

PortalException

updatePhone

public static 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.

Important: Inspect PhoneLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

phone - the phone

Returns:

the phone that was updated

getService

public static PhoneLocalService getService()