Liferay 7.0-ce-b4

com.liferay.portal.service.impl
Class CompanyLocalServiceImpl

java.lang.Object
  extended by com.liferay.portal.service.BaseLocalServiceImpl
      extended by com.liferay.portal.service.base.CompanyLocalServiceBaseImpl
          extended by com.liferay.portal.service.impl.CompanyLocalServiceImpl
All Implemented Interfaces:
IdentifiableOSGiService, BaseLocalService, CompanyLocalService, PersistedModelLocalService

public class CompanyLocalServiceImpl
extends CompanyLocalServiceBaseImpl

Provides the local service for adding, checking, and updating companies. Each company refers to a separate portal instance.


Nested Class Summary
protected  class CompanyLocalServiceImpl.DeleteGroupActionableDynamicQuery
           
protected  class CompanyLocalServiceImpl.DeleteOrganizationActionableDynamicQuery
           
 
Field Summary
 
Fields inherited from class com.liferay.portal.service.base.CompanyLocalServiceBaseImpl
accountLocalService, accountPersistence, companyLocalService, companyPersistence, contactLocalService, contactPersistence, counterLocalService, groupFinder, groupLocalService, groupPersistence, imageLocalService, imagePersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, organizationFinder, organizationLocalService, organizationPersistence, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, persistedModelLocalServiceRegistry, portalPreferencesLocalService, portalPreferencesPersistence, portletLocalService, portletPersistence, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, roleFinder, roleLocalService, rolePersistence, userFinder, userLocalService, userPersistence, virtualHostLocalService, virtualHostPersistence
 
Constructor Summary
CompanyLocalServiceImpl()
           
 
Method Summary
 Company addCompany(String webId, String virtualHostname, String mx, boolean system, int maxUsers, boolean active)
          Adds a company.
 Company checkCompany(String webId)
          Returns the company with the web domain.
 Company checkCompany(String webId, String mx)
          Returns the company with the web domain and mail domain.
 void checkCompanyKey(long companyId)
          Checks if the company has an encryption key.
protected  Company checkLogo(long companyId)
           
 Company deleteCompany(Company company)
          Deletes the company from the database.
 Company deleteCompany(long companyId)
          Deletes the company with the primary key from the database.
 Company deleteLogo(long companyId)
          Deletes the company's logo.
protected  Company doDeleteCompany(long companyId)
           
 Company fetchCompanyById(long companyId)
          Returns the company with the primary key.
 Company fetchCompanyByVirtualHost(String virtualHostname)
          Returns the company with the virtual host name.
 List<Company> getCompanies()
          Returns all the companies.
 List<Company> getCompanies(boolean system)
          Returns all the companies used by WSRP.
 List<Company> getCompanies(boolean system, int start, int end)
           
 int getCompaniesCount(boolean system)
          Returns the number of companies used by WSRP.
 Company getCompanyById(long companyId)
          Returns the company with the primary key.
 Company getCompanyByLogoId(long logoId)
          Returns the company with the logo.
 Company getCompanyByMx(String mx)
          Returns the company with the mail domain.
 Company getCompanyByVirtualHost(String virtualHostname)
          Returns the company with the virtual host name.
 Company getCompanyByWebId(String webId)
          Returns the company with the web domain.
 long getCompanyIdByUserId(long userId)
          Returns the user's company.
 void removePreferences(long companyId, String[] keys)
          Removes the values that match the keys of the company's preferences.
 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.
 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.
protected  void updateAccount(Company company, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size)
           
 Company updateCompany(long companyId, String virtualHostname, String mx, int maxUsers, boolean active)
          Updates the company.
 Company updateCompany(long companyId, String virtualHostname, String mx, String homeURL, boolean logo, byte[] logoBytes, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size)
          Update the company with additional account information.
 Company updateCompany(long companyId, String virtualHostname, String mx, String homeURL, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size)
          Deprecated. As of 7.0.0, replaced by updateCompany(long, String, String, String, boolean, byte[], String, String, String, String, String, String, String, String, String)
 void updateDisplay(long companyId, String languageId, String timeZoneId)
          Update the company's display.
 Company updateLogo(long companyId, byte[] bytes)
          Updates the company's logo.
 Company updateLogo(long companyId, File file)
          Updates the company's logo.
 Company updateLogo(long companyId, InputStream is)
          Update the company's logo.
 void updatePreferences(long companyId, UnicodeProperties properties)
          Updates the company's preferences.
 void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo)
          Updates the company's security properties.
protected  void updateVirtualHostname(long companyId, String virtualHostname)
           
protected  void validateLanguageIds(String languageIds)
           
protected  void validateMx(String mx)
           
protected  void validateName(long companyId, String name)
           
protected  void validateVirtualHost(String webId, String virtualHostname)
           
 
Methods inherited from class com.liferay.portal.service.base.CompanyLocalServiceBaseImpl
addCompany, afterPropertiesSet, createCompany, deletePersistedModel, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchCompany, getAccountLocalService, getAccountPersistence, getActionableDynamicQuery, getCompanies, getCompaniesCount, getCompany, getCompanyLocalService, getCompanyPersistence, getContactLocalService, getContactPersistence, getCounterLocalService, getGroupFinder, getGroupLocalService, getGroupPersistence, getImageLocalService, getImagePersistence, getIndexableActionableDynamicQuery, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationLocalService, getOrganizationPersistence, getOSGiServiceIdentifier, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPersistedModel, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortletLocalService, getPortletPersistence, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, getUserFinder, getUserLocalService, getUserPersistence, getVirtualHostLocalService, getVirtualHostPersistence, initActionableDynamicQuery, runSQL, setAccountLocalService, setAccountPersistence, setCompanyLocalService, setCompanyPersistence, setContactLocalService, setContactPersistence, setCounterLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setImageLocalService, setImagePersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setOrganizationFinder, setOrganizationLocalService, setOrganizationPersistence, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortletLocalService, setPortletPersistence, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setUserFinder, setUserLocalService, setUserPersistence, setVirtualHostLocalService, setVirtualHostPersistence, updateCompany
 
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl
getClassLoader, getLocalizationMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompanyLocalServiceImpl

public CompanyLocalServiceImpl()
Method Detail

addCompany

public Company addCompany(String webId,
                          String virtualHostname,
                          String mx,
                          boolean system,
                          int maxUsers,
                          boolean active)
                   throws PortalException
Adds a company.

Parameters:
webId - the the company's web domain
virtualHostname - the company's virtual host name
mx - the company's mail domain
system - whether the company is the very first company (i.e., the super company)
maxUsers - the max number of company users (optionally 0)
active - whether the company is active
Returns:
the company
Throws:
PortalException

checkCompany

public 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

checkCompany

public Company checkCompany(String webId,
                            String mx)
                     throws PortalException
Returns the company with the web domain and mail domain. If no such company exits, the method will create a new company. The method goes through a series of checks to ensure that the company contains default users, groups, etc.

Parameters:
webId - the company's web domain
mx - the company's mail domain
Returns:
the company with the web domain and mail domain
Throws:
PortalException

checkCompanyKey

public 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

deleteCompany

public Company deleteCompany(Company company)
                      throws PortalException
Description copied from class: CompanyLocalServiceBaseImpl
Deletes the company from the database. Also notifies the appropriate model listeners.

Specified by:
deleteCompany in interface CompanyLocalService
Overrides:
deleteCompany in class CompanyLocalServiceBaseImpl
Parameters:
company - the company
Returns:
the company that was removed
Throws:
PortalException

deleteCompany

public Company deleteCompany(long companyId)
                      throws PortalException
Description copied from class: CompanyLocalServiceBaseImpl
Deletes the company with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
deleteCompany in interface CompanyLocalService
Overrides:
deleteCompany in class CompanyLocalServiceBaseImpl
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

public 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

fetchCompanyById

public 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

public 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

getCompanies

public List<Company> getCompanies()
Returns all the companies.

Returns:
the companies

getCompanies

public List<Company> getCompanies(boolean system)
Returns all the companies used by WSRP.

Parameters:
system - whether the company is the very first company (i.e., the super company)
Returns:
the companies used by WSRP

getCompanies

public List<Company> getCompanies(boolean system,
                                  int start,
                                  int end)

getCompaniesCount

public int getCompaniesCount(boolean system)
Returns the number of companies used by WSRP.

Parameters:
system - whether the company is the very first company (i.e., the super company)
Returns:
the number of companies used by WSRP

getCompanyById

public 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

public 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

public Company getCompanyByMx(String mx)
                       throws PortalException
Returns the company with the mail domain.

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

getCompanyByVirtualHost

public 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

public 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

public 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

removePreferences

public 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

public 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 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

public 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

public 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

public Company updateCompany(long companyId,
                             String virtualHostname,
                             String mx,
                             String homeURL,
                             boolean logo,
                             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)
logo - whether to update the company's 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

updateCompany

@Deprecated
public Company updateCompany(long companyId,
                                        String virtualHostname,
                                        String mx,
                                        String homeURL,
                                        String name,
                                        String legalName,
                                        String legalId,
                                        String legalType,
                                        String sicCode,
                                        String tickerSymbol,
                                        String industry,
                                        String type,
                                        String size)
                      throws PortalException
Deprecated. As of 7.0.0, replaced by updateCompany(long, String, String, String, boolean, byte[], String, String, String, String, String, String, String, String, String)

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)
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

public 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

public 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

public 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

public Company updateLogo(long companyId,
                          InputStream is)
                   throws PortalException
Update the company's logo.

Parameters:
companyId - the primary key of the company
is - the input stream of the company's logo image
Returns:
the company with the primary key
Throws:
PortalException

updatePreferences

public void updatePreferences(long companyId,
                              UnicodeProperties properties)
                       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
properties - the company's properties. See UnicodeProperties
Throws:
PortalException

updateSecurity

public 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

checkLogo

protected Company checkLogo(long companyId)
                     throws PortalException
Throws:
PortalException

doDeleteCompany

protected Company doDeleteCompany(long companyId)
                           throws PortalException
Throws:
PortalException

updateAccount

protected void updateAccount(Company company,
                             String name,
                             String legalName,
                             String legalId,
                             String legalType,
                             String sicCode,
                             String tickerSymbol,
                             String industry,
                             String type,
                             String size)

updateVirtualHostname

protected void updateVirtualHostname(long companyId,
                                     String virtualHostname)
                              throws CompanyVirtualHostException
Throws:
CompanyVirtualHostException

validateLanguageIds

protected void validateLanguageIds(String languageIds)
                            throws PortalException
Throws:
PortalException

validateMx

protected void validateMx(String mx)
                   throws PortalException
Throws:
PortalException

validateName

protected void validateName(long companyId,
                            String name)
                     throws PortalException
Throws:
PortalException

validateVirtualHost

protected void validateVirtualHost(String webId,
                                   String virtualHostname)
                            throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4