Class PhoneLocalServiceUtil
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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PhoneAdds the phone to the database.static PhoneaddPhone(String externalReferenceCode, long userId, String className, long classPK, String number, String extension, long listTypeId, boolean primary, ServiceContext serviceContext) static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static PhonecreatePhone(long phoneId) Creates a new phone with the primary key.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static PhonedeletePhone(long phoneId) Deletes the phone with the primary key from the database.static PhonedeletePhone(Phone phone) Deletes the phone from the database.static voiddeletePhones(long companyId, String className, long classPK) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <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 longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static PhonefetchPhone(long phoneId) static PhonefetchPhoneByExternalReferenceCode(String externalReferenceCode, long companyId) static PhonefetchPhoneByUuidAndCompanyId(String uuid, long companyId) Returns the phone with the matching UUID and company.static ActionableDynamicQuerystatic ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static PhonegetPhone(long phoneId) Returns the phone with the primary key.static PhonegetPhoneByExternalReferenceCode(String externalReferenceCode, long companyId) static PhonegetPhoneByUuidAndCompanyId(String uuid, long companyId) Returns the phone with the matching UUID and company.getPhones(int start, int end) Returns a range of all the phones.static intReturns the number of phones.static PhoneLocalServicestatic voidsetService(PhoneLocalService service) static PhoneupdatePhone(Phone phone) Updates the phone in the database or adds it if it does not yet exist.static PhoneupdatePhone(String externalReferenceCode, long phoneId, String number, String extension, long listTypeId, boolean primary)
-
Constructor Details
-
PhoneLocalServiceUtil
public PhoneLocalServiceUtil()
-
-
Method Details
-
addPhone
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
-
addPhone
public static Phone addPhone(String externalReferenceCode, long userId, String className, long classPK, String number, String extension, long listTypeId, boolean primary, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createPhone
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
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
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
-
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PhoneModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PhoneModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPhone
-
fetchPhoneByExternalReferenceCode
-
fetchPhoneByUuidAndCompanyId
Returns the phone with the matching UUID and company.- Parameters:
uuid- the phone's UUIDcompanyId- the primary key of the company- Returns:
- the matching phone, or
nullif a matching phone could not be found
-
getActionableDynamicQuery
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getPhone
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
-
getPhoneByExternalReferenceCode
public static Phone getPhoneByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getPhoneByUuidAndCompanyId
Returns the phone with the matching UUID and company.- Parameters:
uuid- the phone's UUIDcompanyId- the primary key of the company- Returns:
- the matching phone
- Throws:
PortalException- if a matching phone could not be found
-
getPhones
-
getPhones
Returns a range of all the phones.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PhoneModelImpl.- Parameters:
start- the lower bound of the range of phonesend- the upper bound of the range of phones (not inclusive)- Returns:
- the range of phones
-
getPhones
-
getPhonesCount
public static int getPhonesCount()Returns the number of phones.- Returns:
- the number of phones
-
updatePhone
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
-
updatePhone
public static Phone updatePhone(String externalReferenceCode, long phoneId, String number, String extension, long listTypeId, boolean primary) throws PortalException - Throws:
PortalException
-
getService
-
setService
-