Class EmailAddressLocalServiceUtil
com.liferay.portal.service.impl.EmailAddressLocalServiceImpl
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 EmailAddress
addEmailAddress
(EmailAddress emailAddress) Adds the email address to the database.static EmailAddress
addEmailAddress
(String externalReferenceCode, long userId, String className, long classPK, String address, long listTypeId, boolean primary, ServiceContext serviceContext) static EmailAddress
createEmailAddress
(long emailAddressId) Creates a new email address with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static EmailAddress
deleteEmailAddress
(long emailAddressId) Deletes the email address with the primary key from the database.static EmailAddress
deleteEmailAddress
(EmailAddress emailAddress) Deletes the email address from the database.static void
deleteEmailAddresses
(long companyId, String className, long classPK) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) 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
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 EmailAddress
fetchEmailAddress
(long emailAddressId) static EmailAddress
fetchEmailAddressByExternalReferenceCode
(String externalReferenceCode, long companyId) static EmailAddress
fetchEmailAddressByUuidAndCompanyId
(String uuid, long companyId) Returns the email address with the matching UUID and company.static ActionableDynamicQuery
static EmailAddress
getEmailAddress
(long emailAddressId) Returns the email address with the primary key.static EmailAddress
getEmailAddressByExternalReferenceCode
(String externalReferenceCode, long companyId) static EmailAddress
getEmailAddressByUuidAndCompanyId
(String uuid, long companyId) Returns the email address with the matching UUID and company.static List<EmailAddress>
static List<EmailAddress>
getEmailAddresses
(int start, int end) Returns a range of all the email addresses.static List<EmailAddress>
getEmailAddresses
(long companyId, String className, long classPK) static int
Returns the number of email addresses.static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static EmailAddressLocalService
static void
setService
(EmailAddressLocalService service) static EmailAddress
updateEmailAddress
(EmailAddress emailAddress) Updates the email address in the database or adds it if it does not yet exist.static EmailAddress
updateEmailAddress
(String externalReferenceCode, long emailAddressId, String address, long listTypeId, boolean primary)
-
Constructor Details
-
EmailAddressLocalServiceUtil
public EmailAddressLocalServiceUtil()
-
-
Method Details
-
addEmailAddress
Adds the email address to the database. Also notifies the appropriate model listeners.Important: Inspect EmailAddressLocalServiceImpl 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:
emailAddress
- the email address- Returns:
- the email address that was added
-
addEmailAddress
public static EmailAddress addEmailAddress(String externalReferenceCode, long userId, String className, long classPK, String address, long listTypeId, boolean primary, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createEmailAddress
Creates a new email address with the primary key. Does not add the email address to the database.- Parameters:
emailAddressId
- the primary key for the new email address- Returns:
- the new email address
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteEmailAddress
Deletes the email address from the database. Also notifies the appropriate model listeners.Important: Inspect EmailAddressLocalServiceImpl 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:
emailAddress
- the email address- Returns:
- the email address that was removed
-
deleteEmailAddress
Deletes the email address with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect EmailAddressLocalServiceImpl 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:
emailAddressId
- the primary key of the email address- Returns:
- the email address that was removed
- Throws:
PortalException
- if a email address with the primary key could not be found
-
deleteEmailAddresses
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.EmailAddressModelImpl
.- 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.EmailAddressModelImpl
.- 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
-
fetchEmailAddress
-
fetchEmailAddressByExternalReferenceCode
public static EmailAddress fetchEmailAddressByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchEmailAddressByUuidAndCompanyId
Returns the email address with the matching UUID and company.- Parameters:
uuid
- the email address's UUIDcompanyId
- the primary key of the company- Returns:
- the matching email address, or
null
if a matching email address could not be found
-
getActionableDynamicQuery
-
getEmailAddress
Returns the email address with the primary key.- Parameters:
emailAddressId
- the primary key of the email address- Returns:
- the email address
- Throws:
PortalException
- if a email address with the primary key could not be found
-
getEmailAddressByExternalReferenceCode
public static EmailAddress getEmailAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getEmailAddressByUuidAndCompanyId
public static EmailAddress getEmailAddressByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the email address with the matching UUID and company.- Parameters:
uuid
- the email address's UUIDcompanyId
- the primary key of the company- Returns:
- the matching email address
- Throws:
PortalException
- if a matching email address could not be found
-
getEmailAddresses
-
getEmailAddresses
Returns a range of all the email addresses.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.EmailAddressModelImpl
.- Parameters:
start
- the lower bound of the range of email addressesend
- the upper bound of the range of email addresses (not inclusive)- Returns:
- the range of email addresses
-
getEmailAddresses
-
getEmailAddressesCount
public static int getEmailAddressesCount()Returns the number of email addresses.- Returns:
- the number of email addresses
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
updateEmailAddress
Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect EmailAddressLocalServiceImpl 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:
emailAddress
- the email address- Returns:
- the email address that was updated
-
updateEmailAddress
public static EmailAddress updateEmailAddress(String externalReferenceCode, long emailAddressId, String address, long listTypeId, boolean primary) throws PortalException - Throws:
PortalException
-
getService
-
setService
-