Interface CompanyService

All Superinterfaces:
BaseService
All Known Implementing Classes:
CompanyServiceWrapper

Provides the remote service interface for Company. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • addCompany

      @JSONWebService(mode=IGNORE) Company addCompany(long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active) throws 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:
      PortalException
    • addCompany

      @JSONWebService(mode=IGNORE) 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 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:
      PortalException
    • deleteCompany

      @JSONWebService(mode=IGNORE) Company deleteCompany(long companyId) throws PortalException
      Throws:
      PortalException
    • deleteLogo

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

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

      Returns all the companies.
      Returns:
      the companies
    • getCompanyById

      @Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyById(long companyId) throws 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:
      PortalException
    • getCompanyByLogoId

      @Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByLogoId(long logoId) throws PortalException
      Returns the company with the logo.
      Parameters:
      logoId - the ID of the company's logo
      Returns:
      Returns the company with the logo
      Throws:
      PortalException
    • getCompanyByMx

      Returns the company with the mail domian.
      Parameters:
      mx - the company's mail domain
      Returns:
      Returns the company with the mail domain
      Throws:
      PortalException
    • getCompanyByVirtualHost

      @Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByVirtualHost(String virtualHost) throws 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:
      PortalException
    • getCompanyByWebId

      @Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByWebId(String webId) throws PortalException
      Returns the company with the web domain.
      Parameters:
      webId - the company's web domain
      Returns:
      Returns the company with the web domain
      Throws:
      PortalException
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • removePreferences

      void removePreferences(long companyId, String[] keys) throws 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:
      PortalException
    • updateCompany

      Company updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) throws 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:
      PortalException
    • updateCompany

      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 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:
      PortalException
    • updateCompany

      @JSONWebService(mode=IGNORE) 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<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, UnicodeProperties unicodeProperties) throws 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:
      PortalException
    • updateDisplay

      void updateDisplay(long companyId, String languageId, String timeZoneId) throws 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:
      PortalException
    • updateLogo

      Company updateLogo(long companyId, byte[] bytes) throws 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:
      PortalException
    • updateLogo

      @JSONWebService(mode=IGNORE) Company updateLogo(long companyId, InputStream inputStream) throws 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:
      PortalException
    • updatePreferences

      void updatePreferences(long companyId, UnicodeProperties unicodeProperties) throws 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:
      PortalException
    • updateSecurity

      @JSONWebService(mode=IGNORE) void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo) throws 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:
      PortalException