Class CompanyServiceImpl

Object
com.liferay.portal.kernel.service.BaseServiceImpl
com.liferay.portal.service.base.CompanyServiceBaseImpl
com.liferay.portal.service.impl.CompanyServiceImpl
All Implemented Interfaces:
com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.CompanyService

@JSONWebService public class CompanyServiceImpl extends CompanyServiceBaseImpl
Provides the local service for accessing, adding, checking, and updating companies. Its methods include permission checks. Each company refers to a separate portal instance.
Author:
Brian Wing Shun Chan, Julio Camarero
  • Constructor Details

    • CompanyServiceImpl

      public CompanyServiceImpl()
  • Method Details

    • addCompany

      @JSONWebService(mode=IGNORE) public com.liferay.portal.kernel.model.Company addCompany(long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active) throws com.liferay.portal.kernel.exception.PortalException
      Adds a company.
      Parameters:
      companyId - the primary key of the company (optionally null or * 0 to generate a key automatically)
      webId - the company's web domain
      virtualHost - the company's virtual host name
      mx - the company's mail domain
      maxUsers - the max number of company users (optionally 0)
      active - whether the company is active
      Returns:
      the company
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCompany

      @JSONWebService(mode=IGNORE) public com.liferay.portal.kernel.model.Company addCompany(Long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active, String defaultAdminPassword, String defaultAdminScreenName, String defaultAdminEmailAddress, String defaultAdminFirstName, String defaultAdminMiddleName, String defaultAdminLastName) throws com.liferay.portal.kernel.exception.PortalException
      Adds a company.
      Parameters:
      webId - the company's web domain
      virtualHost - the company's virtual host name
      mx - the company's mail domain
      maxUsers - the max number of company users (optionally 0)
      active - whether the company is active
      Returns:
      the company
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCompany

      @JSONWebService(mode=IGNORE) public com.liferay.portal.kernel.model.Company deleteCompany(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteLogo

      public void deleteLogo(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the company's logo.
      Parameters:
      companyId - the primary key of the company
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • forEachCompany

      public void forEachCompany(com.liferay.petra.function.UnsafeConsumer<com.liferay.portal.kernel.model.Company,Exception> unsafeConsumer) throws Exception
      Throws:
      Exception
    • getCompanies

      public List<com.liferay.portal.kernel.model.Company> getCompanies()
      Returns all the companies.
      Returns:
      the companies
    • getCompanyById

      public com.liferay.portal.kernel.model.Company getCompanyById(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the company with the primary key.
      Parameters:
      companyId - the primary key of the company
      Returns:
      Returns the company with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCompanyByLogoId

      public com.liferay.portal.kernel.model.Company getCompanyByLogoId(long logoId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the company with the logo.
      Parameters:
      logoId - the ID of the company's logo
      Returns:
      Returns the company with the logo
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCompanyByMx

      public com.liferay.portal.kernel.model.Company getCompanyByMx(String mx) throws com.liferay.portal.kernel.exception.PortalException
      Returns the company with the mail domian.
      Parameters:
      mx - the company's mail domain
      Returns:
      Returns the company with the mail domain
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCompanyByVirtualHost

      public com.liferay.portal.kernel.model.Company getCompanyByVirtualHost(String virtualHost) throws com.liferay.portal.kernel.exception.PortalException
      Returns the company with the virtual host name.
      Parameters:
      virtualHost - the company's virtual host name
      Returns:
      Returns the company with the virtual host name
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCompanyByWebId

      public com.liferay.portal.kernel.model.Company getCompanyByWebId(String webId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the company with the web domain.
      Parameters:
      webId - the company's web domain
      Returns:
      Returns the company with the web domain
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • removePreferences

      public void removePreferences(long companyId, String[] keys) throws com.liferay.portal.kernel.exception.PortalException
      Removes the values that match the keys of the company's preferences. This method is called by com.liferay.portlet.portalsettings.action.EditLDAPServerAction remotely through CompanyService.
      Parameters:
      companyId - the primary key of the company
      keys - the company's preferences keys to be remove
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCompany

      public com.liferay.portal.kernel.model.Company updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company
      Parameters:
      companyId - the primary key of the company
      virtualHost - the company's virtual host name
      mx - the company's mail domain
      maxUsers - the max number of company users (optionally 0)
      active - whether the company is active
      Returns:
      the company with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCompany

      public com.liferay.portal.kernel.model.Company updateCompany(long companyId, String virtualHost, String mx, String homeURL, boolean hasLogo, byte[] logoBytes, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company with additional account information.
      Parameters:
      companyId - the primary key of the company
      virtualHost - the company's virtual host name
      mx - the company's mail domain
      homeURL - the company's home URL (optionally null)
      hasLogo - if the company has a custom logo
      logoBytes - the new logo image data
      name - the company's account name (optionally null)
      legalName - the company's account legal name (optionally null)
      legalId - the company's account legal ID (optionally null)
      legalType - the company's account legal type (optionally null)
      sicCode - the company's account SIC code (optionally null)
      tickerSymbol - the company's account ticker symbol (optionally null)
      industry - the the company's account industry (optionally null)
      type - the company's account type (optionally null)
      size - the company's account size (optionally null)
      Returns:
      the the company with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCompany

      @JSONWebService(mode=IGNORE) public com.liferay.portal.kernel.model.Company updateCompany(long companyId, String virtualHost, String mx, String homeURL, boolean hasLogo, byte[] logoBytes, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size, String languageId, String timeZoneId, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.util.UnicodeProperties unicodeProperties) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company with addition information.
      Parameters:
      companyId - the primary key of the company
      virtualHost - the company's virtual host name
      mx - the company's mail domain
      homeURL - the company's home URL (optionally null)
      hasLogo - if the company has a custom logo
      logoBytes - the new logo image data
      name - the company's account name (optionally null)
      legalName - the company's account legal name (optionally null)
      legalId - the company's accout legal ID (optionally null)
      legalType - the company's account legal type (optionally null)
      sicCode - the company's account SIC code (optionally null)
      tickerSymbol - the company's account ticker symbol (optionally null)
      industry - the the company's account industry (optionally null)
      type - the company's account type (optionally null)
      size - the company's account size (optionally null)
      languageId - the ID of the company's default user's language
      timeZoneId - the ID of the company's default user's time zone
      addresses - the company's addresses
      emailAddresses - the company's email addresses
      phones - the company's phone numbers
      websites - the company's websites
      unicodeProperties - the company's properties
      Returns:
      the company with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateDisplay

      public void updateDisplay(long companyId, String languageId, String timeZoneId) throws com.liferay.portal.kernel.exception.PortalException
      Update the company's display.
      Parameters:
      companyId - the primary key of the company
      languageId - the ID of the company's default user's language
      timeZoneId - the ID of the company's default user's time zone
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLogo

      public com.liferay.portal.kernel.model.Company updateLogo(long companyId, byte[] bytes) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company's logo.
      Parameters:
      companyId - the primary key of the company
      bytes - the bytes of the company's logo image
      Returns:
      the company with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLogo

      @JSONWebService(mode=IGNORE) public com.liferay.portal.kernel.model.Company updateLogo(long companyId, InputStream inputStream) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company's logo.
      Parameters:
      companyId - the primary key of the company
      inputStream - the input stream of the company's logo image
      Returns:
      the company with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updatePreferences

      public void updatePreferences(long companyId, com.liferay.portal.kernel.util.UnicodeProperties unicodeProperties) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company's preferences. The company's default properties are found in portal.properties.
      Parameters:
      companyId - the primary key of the company
      unicodeProperties - the company's properties. See UnicodeProperties
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSecurity

      @JSONWebService(mode=IGNORE) public void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo) throws com.liferay.portal.kernel.exception.PortalException
      Updates the company's security properties.
      Parameters:
      companyId - the primary key of the company
      authType - the company's method of authenticating users
      autoLogin - whether to allow users to select the "remember me" feature
      sendPassword - whether to allow users to ask the company to send their passwords
      strangers - whether to allow strangers to create accounts to register themselves in the company
      strangersWithMx - whether to allow strangers to create accounts with email addresses that match the company mail suffix
      strangersVerify - whether to require strangers who create accounts to be verified via email
      siteLogo - whether to to allow site administrators to use their own logo instead of the enterprise logo
      Throws:
      com.liferay.portal.kernel.exception.PortalException