Class EmailAddressLocalServiceUtil

Object
com.liferay.portal.kernel.service.EmailAddressLocalServiceUtil

public class EmailAddressLocalServiceUtil extends Object
Provides the local service utility for EmailAddress. This utility wraps 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 Details

    • EmailAddressLocalServiceUtil

      public EmailAddressLocalServiceUtil()
  • Method Details

    • addEmailAddress

      public static EmailAddress addEmailAddress(EmailAddress emailAddress)
      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

      public static EmailAddress createEmailAddress(long emailAddressId)
      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

      public static EmailAddress deleteEmailAddress(EmailAddress emailAddress)
      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

      public static EmailAddress deleteEmailAddress(long emailAddressId) throws PortalException
      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

      public static void deleteEmailAddresses(long companyId, String className, long classPK)
    • 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

      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.EmailAddressModelImpl.

      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.EmailAddressModelImpl.

      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
    • fetchEmailAddress

      public static EmailAddress fetchEmailAddress(long emailAddressId)
    • fetchEmailAddressByExternalReferenceCode

      public static EmailAddress fetchEmailAddressByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchEmailAddressByUuidAndCompanyId

      public static EmailAddress fetchEmailAddressByUuidAndCompanyId(String uuid, long companyId)
      Returns the email address with the matching UUID and company.
      Parameters:
      uuid - the email address's UUID
      companyId - the primary key of the company
      Returns:
      the matching email address, or null if a matching email address could not be found
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getEmailAddress

      public static EmailAddress getEmailAddress(long emailAddressId) throws PortalException
      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 UUID
      companyId - the primary key of the company
      Returns:
      the matching email address
      Throws:
      PortalException - if a matching email address could not be found
    • getEmailAddresses

      public static List<EmailAddress> getEmailAddresses()
    • getEmailAddresses

      public static List<EmailAddress> getEmailAddresses(int start, int end)
      Returns a range of all the email addresses.

      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.EmailAddressModelImpl.

      Parameters:
      start - the lower bound of the range of email addresses
      end - the upper bound of the range of email addresses (not inclusive)
      Returns:
      the range of email addresses
    • getEmailAddresses

      public static List<EmailAddress> getEmailAddresses(long companyId, String className, long classPK)
    • 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

      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
    • updateEmailAddress

      public static EmailAddress updateEmailAddress(EmailAddress emailAddress)
      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

      public static EmailAddressLocalService getService()
    • setService

      public static void setService(EmailAddressLocalService service)