Interface CompanyLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
CompanyLocalServiceWrapper

Provides the local service interface for Company. 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}
  • Method Details

    • addCompany

      @Indexable(type=REINDEX) Company addCompany(Company company)
      Adds the company to the database. Also notifies the appropriate model listeners.

      Important: Inspect CompanyLocalServiceImpl 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:
      company - the company
      Returns:
      the company that was added
    • addCompany

      Company addCompany(Long companyId, String webId, String virtualHostname, String mx, int maxUsers, boolean active, boolean addDefaultAdminUser, String defaultAdminPassword, String defaultAdminScreenName, String defaultAdminEmailAddress, String defaultAdminFirstName, String defaultAdminMiddleName, String defaultAdminLastName) throws PortalException
      Adds a company with the primary key.
      Parameters:
      companyId - the primary key of the company (optionally null or 0 to generate a key automatically)
      webId - the the company's web domain
      virtualHostname - 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
    • addDBPartitionCompany

      Company addDBPartitionCompany(long companyId, String name, String virtualHostname, String webId) throws PortalException
      Throws:
      PortalException
    • checkCompany

      Company checkCompany(String webId) throws PortalException
      Returns the company with the web domain. The method sets mail domain to the web domain to the default name set in portal.properties
      Parameters:
      webId - the company's web domain
      Returns:
      the company with the web domain
      Throws:
      PortalException
    • checkCompanyKey

      void checkCompanyKey(long companyId) throws PortalException
      Checks if the company has an encryption key. It will create a key if one does not exist.
      Parameters:
      companyId - the primary key of the company
      Throws:
      PortalException
    • copyDBPartitionCompany

      Company copyDBPartitionCompany(long fromCompanyId, Long toCompanyId, String name, String virtualHostname, String webId) throws PortalException
      Throws:
      PortalException
    • createCompany

      @Transactional(enabled=false) Company createCompany(long companyId)
      Creates a new company with the primary key. Does not add the company to the database.
      Parameters:
      companyId - the primary key for the new company
      Returns:
      the new company
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteCompany

      @Indexable(type=DELETE) Company deleteCompany(Company company) throws PortalException
      Deletes the company from the database. Also notifies the appropriate model listeners.

      Important: Inspect CompanyLocalServiceImpl 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:
      company - the company
      Returns:
      the company that was removed
      Throws:
      PortalException
    • deleteCompany

      @Indexable(type=DELETE) Company deleteCompany(long companyId) throws PortalException
      Deletes the company with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CompanyLocalServiceImpl 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:
      companyId - the primary key of the company
      Returns:
      the company that was removed
      Throws:
      PortalException - if a company with the primary key could not be found
    • deleteLogo

      Company deleteLogo(long companyId) throws PortalException
      Deletes the company's logo.
      Parameters:
      companyId - the primary key of the company
      Returns:
      the deleted logo's company
      Throws:
      PortalException
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • dynamicQuery

    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.CompanyModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.CompanyModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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
    • extractDBPartitionCompany

      Company extractDBPartitionCompany(long companyId) throws PortalException
      Throws:
      PortalException
    • fetchCompany

      @Transactional(propagation=SUPPORTS, readOnly=true) Company fetchCompany(long companyId)
    • fetchCompanyById

      @Transactional(propagation=SUPPORTS, readOnly=true) Company fetchCompanyById(long companyId)
      Returns the company with the primary key.
      Parameters:
      companyId - the primary key of the company
      Returns:
      the company with the primary key, null if a company with the primary key could not be found
    • fetchCompanyByVirtualHost

      @Transactional(propagation=SUPPORTS, readOnly=true) Company fetchCompanyByVirtualHost(String virtualHostname)
      Returns the company with the virtual host name.
      Parameters:
      virtualHostname - the virtual host name
      Returns:
      the company with the virtual host name, null if a company with the virtual host could not be found
    • forEachCompany

      @Transactional(enabled=false) <E extends Exception> void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company,E> unsafeConsumer) throws E
      Throws:
      E extends Exception
    • forEachCompany

      @Transactional(enabled=false) <E extends Exception> void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company,E> unsafeConsumer, List<Company> companies) throws E
      Throws:
      E extends Exception
    • forEachCompanyId

      @Transactional(enabled=false) <E extends Exception> void forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long,E> unsafeConsumer) throws E
      Throws:
      E extends Exception
    • forEachCompanyId

      @Transactional(enabled=false) <E extends Exception> void forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long,E> unsafeConsumer, long[] companyIds) throws E
      Throws:
      E extends Exception
    • getActionableDynamicQuery

    • getCompanies

      Returns all the companies.
      Returns:
      the companies
    • getCompanies

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Company> getCompanies(int start, int end)
      Returns a range of all the companies.

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

      Parameters:
      start - the lower bound of the range of companies
      end - the upper bound of the range of companies (not inclusive)
      Returns:
      the range of companies
    • getCompaniesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCompaniesCount()
      Returns the number of companies.
      Returns:
      the number of companies
    • getCompany

      @Transactional(propagation=SUPPORTS, readOnly=true) Company getCompany(long companyId) throws PortalException
      Returns the company with the primary key.
      Parameters:
      companyId - the primary key of the company
      Returns:
      the company
      Throws:
      PortalException - if a company with the primary key could not be found
    • 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:
      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:
      the company with the logo
      Throws:
      PortalException
    • getCompanyByMx

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

      @Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByVirtualHost(String virtualHostname) throws PortalException
      Returns the company with the virtual host name.
      Parameters:
      virtualHostname - the company's virtual host name
      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:
      the company with the web domain
      Throws:
      PortalException
    • getCompanyIdByUserId

      @Transactional(propagation=SUPPORTS, readOnly=true) long getCompanyIdByUserId(long userId) throws Exception
      Returns the user's company.
      Parameters:
      userId - the primary key of the user
      Returns:
      Returns the first company if there is only one company or the user's company if there are more than one company; 0 otherwise
      Throws:
      Exception - if a user with the primary key could not be found
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • removePreferences

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

      @Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, long userId, String keywords, int start, int end)
      Returns an ordered range of all assets that match the keywords in the company. The method is called in com.liferay.portal.search.PortalOpenSearchImpl which is not longer used by the Search portlet.
      Parameters:
      companyId - the primary key of the company
      userId - the primary key of the user
      keywords - the keywords (space separated),which may occur in assets in the company (optionally null)
      start - the lower bound of the range of assets to return
      end - the upper bound of the range of assets to return (not inclusive)
      Returns:
      the matching assets in the company
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, long userId, String portletId, long groupId, String type, String keywords, int start, int end)
      Returns an ordered range of all assets that match the keywords in the portlet within the company.
      Parameters:
      companyId - the primary key of the company
      userId - the primary key of the user
      portletId - the primary key of the portlet (optionally null)
      groupId - the primary key of the group (optionally 0)
      type - the mime type of assets to return(optionally null)
      keywords - the keywords (space separated), which may occur in any assets in the portlet (optionally null)
      start - the lower bound of the range of assets to return
      end - the upper bound of the range of assets to return (not inclusive)
      Returns:
      the matching assets in the portlet within the company
    • updateCompany

      @Indexable(type=REINDEX) Company updateCompany(Company company)
      Updates the company in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CompanyLocalServiceImpl 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:
      company - the company
      Returns:
      the company that was updated
    • updateCompany

      Company updateCompany(long companyId, String virtualHostname, String mx, int maxUsers, boolean active) throws PortalException
      Updates the company.
      Parameters:
      companyId - the primary key of the company
      virtualHostname - 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 virtualHostname, 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
      Update the company with additional account information.
      Parameters:
      companyId - the primary key of the company
      virtualHostname - 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 company's account industry (optionally null)
      type - the company's account type (optionally null)
      size - the company's account size (optionally null)
      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
    • updateDisplayGroupNames

      @Async void updateDisplayGroupNames(long companyId) throws PortalException
      Throws:
      PortalException
    • updateIndexNameNext

      Company updateIndexNameNext(long companyId, String indexNameNext) throws PortalException
      Throws:
      PortalException
    • updateIndexNames

      Company updateIndexNames(long companyId, String indexNameCurrent, String indexNameNext) throws PortalException
      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

      Company updateLogo(long companyId, File file) throws PortalException
      Updates the company's logo.
      Parameters:
      companyId - the primary key of the company
      file - the file of the company's logo image
      Returns:
      the company with the primary key
      Throws:
      PortalException
    • updateLogo

      Company updateLogo(long companyId, InputStream inputStream) throws PortalException
      Update 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

      void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo)
      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 password
      strangers - whether to allow strangers to create accounts 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 allow site administrators to use their own logo instead of the enterprise logo