com.liferay.portal.service.impl

Class CompanyLocalServiceImpl

java.lang.Object

com.liferay.portal.service.BaseLocalServiceImpl

com.liferay.portal.service.base.CompanyLocalServiceBaseImpl

com.liferay.portal.service.impl.CompanyLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.bean.IdentifiableBean, com.liferay.portal.service.BaseLocalService, com.liferay.portal.service.CompanyLocalService, com.liferay.portal.service.PersistedModelLocalService

public class CompanyLocalServiceImpl
extends CompanyLocalServiceBaseImpl

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

Author:

Brian Wing Shun Chan, Julio Camarero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CompanyLocalServiceImpl.DeleteGroupActionableDynamicQuery
protected class	CompanyLocalServiceImpl.DeleteOrganizationActionableDynamicQuery

Field Summary

Fields inherited from class com.liferay.portal.service.base.CompanyLocalServiceBaseImpl

accountLocalService, accountPersistence, accountService, addressLocalService, addressPersistence, addressService, backgroundTaskLocalService, backgroundTaskPersistence, backgroundTaskService, browserTrackerLocalService, browserTrackerPersistence, classNameLocalService, classNamePersistence, classNameService, clusterGroupLocalService, clusterGroupPersistence, cmisRepositoryLocalService, companyLocalService, companyPersistence, companyService, contactLocalService, contactPersistence, contactService, counterLocalService, countryPersistence, countryService, emailAddressLocalService, emailAddressPersistence, emailAddressService, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, layoutBranchLocalService, layoutBranchPersistence, layoutBranchService, layoutFinder, layoutFriendlyURLLocalService, layoutFriendlyURLPersistence, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutRevisionLocalService, layoutRevisionPersistence, layoutRevisionService, layoutService, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetBranchService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, layoutTemplateLocalService, listTypePersistence, listTypeService, lockFinder, lockLocalService, lockPersistence, membershipRequestLocalService, membershipRequestPersistence, membershipRequestService, organizationFinder, organizationLocalService, organizationPersistence, organizationService, orgGroupRolePersistence, orgLaborLocalService, orgLaborPersistence, orgLaborService, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, passwordPolicyRelLocalService, passwordPolicyRelPersistence, passwordPolicyService, passwordTrackerLocalService, passwordTrackerPersistence, permissionService, persistedModelLocalServiceRegistry, phoneLocalService, phonePersistence, phoneService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, portalLocalService, portalPreferencesLocalService, portalPreferencesPersistence, portalService, portletItemLocalService, portletItemPersistence, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, portletService, quartzLocalService, regionPersistence, regionService, releaseLocalService, releasePersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPermissionLocalService, resourceBlockPermissionPersistence, resourceBlockPersistence, resourceBlockService, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, roleService, serviceComponentLocalService, serviceComponentPersistence, shardLocalService, shardPersistence, stagingLocalService, stagingService, subscriptionLocalService, subscriptionPersistence, systemEventLocalService, systemEventPersistence, teamFinder, teamLocalService, teamPersistence, teamService, themeLocalService, themeService, ticketLocalService, ticketPersistence, userFinder, userGroupFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userGroupRoleService, userGroupService, userIdMapperLocalService, userIdMapperPersistence, userLocalService, userNotificationDeliveryLocalService, userNotificationDeliveryPersistence, userNotificationEventLocalService, userNotificationEventPersistence, userPersistence, userService, userTrackerLocalService, userTrackerPathLocalService, userTrackerPathPersistence, userTrackerPersistence, virtualHostLocalService, virtualHostPersistence, webDAVPropsLocalService, webDAVPropsPersistence, websiteLocalService, websitePersistence, websiteService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence

Constructor Summary

Constructors

Constructor and Description
CompanyLocalServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
com.liferay.portal.model.Company	addCompany(java.lang.String webId, java.lang.String virtualHostname, java.lang.String mx, java.lang.String shardName, boolean system, int maxUsers, boolean active) Adds a company.
com.liferay.portal.model.Company	checkCompany(java.lang.String webId) Returns the company with the web domain.
com.liferay.portal.model.Company	checkCompany(java.lang.String webId, java.lang.String mx, java.lang.String shardName) Returns the company with the web domain, mail domain, and shard.
void	checkCompanyKey(long companyId) Checks if the company has an encryption key.
protected com.liferay.portal.model.Company	checkLogo(long companyId)
com.liferay.portal.model.Company	deleteCompany(long companyId) Deletes the company with the primary key from the database.
void	deleteLogo(long companyId) Deletes the company's logo.
protected com.liferay.portal.model.Company	doDeleteCompany(long companyId)
com.liferay.portal.model.Company	fetchCompanyById(long companyId) Returns the company with the primary key.
com.liferay.portal.model.Company	fetchCompanyByVirtualHost(java.lang.String virtualHostname) Returns the company with the virtual host name.
java.util.List<com.liferay.portal.model.Company>	getCompanies() Returns all the companies.
java.util.List<com.liferay.portal.model.Company>	getCompanies(boolean system) Returns all the companies used by WSRP.
int	getCompaniesCount(boolean system) Returns the number of companies used by WSRP.
com.liferay.portal.model.Company	getCompanyById(long companyId) Returns the company with the primary key.
com.liferay.portal.model.Company	getCompanyByLogoId(long logoId) Returns the company with the logo.
com.liferay.portal.model.Company	getCompanyByMx(java.lang.String mx) Returns the company with the mail domain.
com.liferay.portal.model.Company	getCompanyByVirtualHost(java.lang.String virtualHostname) Returns the company with the virtual host name.
com.liferay.portal.model.Company	getCompanyByWebId(java.lang.String webId) Returns the company with the web domain.
long	getCompanyIdByUserId(long userId) Returns the user's company.
void	removePreferences(long companyId, java.lang.String[] keys) Removes the values that match the keys of the company's preferences.
com.liferay.portal.kernel.search.Hits	search(long companyId, long userId, java.lang.String keywords, int start, int end) Returns an ordered range of all assets that match the keywords in the company.
com.liferay.portal.kernel.search.Hits	search(long companyId, long userId, java.lang.String portletId, long groupId, java.lang.String type, java.lang.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(com.liferay.portal.model.Company company, java.lang.String name, java.lang.String legalName, java.lang.String legalId, java.lang.String legalType, java.lang.String sicCode, java.lang.String tickerSymbol, java.lang.String industry, java.lang.String type, java.lang.String size)
com.liferay.portal.model.Company	updateCompany(long companyId, java.lang.String virtualHostname, java.lang.String mx, int maxUsers, boolean active) Updates the company.
com.liferay.portal.model.Company	updateCompany(long companyId, java.lang.String virtualHostname, java.lang.String mx, java.lang.String homeURL, java.lang.String name, java.lang.String legalName, java.lang.String legalId, java.lang.String legalType, java.lang.String sicCode, java.lang.String tickerSymbol, java.lang.String industry, java.lang.String type, java.lang.String size) Update the company with additional account information.
void	updateDisplay(long companyId, java.lang.String languageId, java.lang.String timeZoneId) Update the company's display.
com.liferay.portal.model.Company	updateLogo(long companyId, byte[] bytes) Updates the company's logo.
com.liferay.portal.model.Company	updateLogo(long companyId, java.io.File file) Updates the company's logo.
com.liferay.portal.model.Company	updateLogo(long companyId, java.io.InputStream is) Update the company's logo.
void	updatePreferences(long companyId, com.liferay.portal.kernel.util.UnicodeProperties properties) Updates the company's preferences.
void	updateSecurity(long companyId, java.lang.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, java.lang.String virtualHostname)
protected void	validateLanguageIds(java.lang.String languageIds)
protected void	validateMx(java.lang.String mx)
protected void	validateName(long companyId, java.lang.String name)
protected void	validateVirtualHost(java.lang.String webId, java.lang.String virtualHostname)

Methods inherited from class com.liferay.portal.service.base.CompanyLocalServiceBaseImpl

addCompany, afterPropertiesSet, createCompany, deleteCompany, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchCompany, getAccountLocalService, getAccountPersistence, getAccountService, getAddressLocalService, getAddressPersistence, getAddressService, getBackgroundTaskLocalService, getBackgroundTaskPersistence, getBackgroundTaskService, getBeanIdentifier, getBrowserTrackerLocalService, getBrowserTrackerPersistence, getClassNameLocalService, getClassNamePersistence, getClassNameService, getClusterGroupLocalService, getClusterGroupPersistence, getCMISRepositoryLocalService, getCompanies, getCompaniesCount, getCompany, getCompanyLocalService, getCompanyPersistence, getCompanyService, getContactLocalService, getContactPersistence, getContactService, getCounterLocalService, getCountryPersistence, getCountryService, getEmailAddressLocalService, getEmailAddressPersistence, getEmailAddressService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getLayoutBranchLocalService, getLayoutBranchPersistence, getLayoutBranchService, getLayoutFinder, getLayoutFriendlyURLLocalService, getLayoutFriendlyURLPersistence, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutRevisionLocalService, getLayoutRevisionPersistence, getLayoutRevisionService, getLayoutService, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetBranchService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getLayoutTemplateLocalService, getListTypePersistence, getListTypeService, getLockFinder, getLockLocalService, getLockPersistence, getMembershipRequestLocalService, getMembershipRequestPersistence, getMembershipRequestService, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionService, getPersistedModel, getPhoneLocalService, getPhonePersistence, getPhoneService, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPortalLocalService, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortalService, getPortletItemLocalService, getPortletItemPersistence, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getPortletService, getQuartzLocalService, getRegionPersistence, getRegionService, getReleaseLocalService, getReleasePersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPermissionLocalService, getResourceBlockPermissionPersistence, getResourceBlockPersistence, getResourceBlockService, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, getServiceComponentLocalService, getServiceComponentPersistence, getShardLocalService, getShardPersistence, getStagingLocalService, getStagingService, getSubscriptionLocalService, getSubscriptionPersistence, getSystemEventLocalService, getSystemEventPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getThemeLocalService, getThemeService, getTicketLocalService, getTicketPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, getUserGroupService, getUserIdMapperLocalService, getUserIdMapperPersistence, getUserLocalService, getUserNotificationDeliveryLocalService, getUserNotificationDeliveryPersistence, getUserNotificationEventLocalService, getUserNotificationEventPersistence, getUserPersistence, getUserService, getUserTrackerLocalService, getUserTrackerPathLocalService, getUserTrackerPathPersistence, getUserTrackerPersistence, getVirtualHostLocalService, getVirtualHostPersistence, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWebsiteLocalService, getWebsitePersistence, getWebsiteService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, runSQL, setAccountLocalService, setAccountPersistence, setAccountService, setAddressLocalService, setAddressPersistence, setAddressService, setBackgroundTaskLocalService, setBackgroundTaskPersistence, setBackgroundTaskService, setBeanIdentifier, setBrowserTrackerLocalService, setBrowserTrackerPersistence, setClassNameLocalService, setClassNamePersistence, setClassNameService, setClusterGroupLocalService, setClusterGroupPersistence, setCMISRepositoryLocalService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setContactLocalService, setContactPersistence, setContactService, setCounterLocalService, setCountryPersistence, setCountryService, setEmailAddressLocalService, setEmailAddressPersistence, setEmailAddressService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setLayoutBranchLocalService, setLayoutBranchPersistence, setLayoutBranchService, setLayoutFinder, setLayoutFriendlyURLLocalService, setLayoutFriendlyURLPersistence, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutRevisionLocalService, setLayoutRevisionPersistence, setLayoutRevisionService, setLayoutService, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetBranchService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setLayoutTemplateLocalService, setListTypePersistence, setListTypeService, setLockFinder, setLockLocalService, setLockPersistence, setMembershipRequestLocalService, setMembershipRequestPersistence, setMembershipRequestService, setOrganizationFinder, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionService, setPhoneLocalService, setPhonePersistence, setPhoneService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPortalLocalService, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortalService, setPortletItemLocalService, setPortletItemPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setPortletService, setQuartzLocalService, setRegionPersistence, setRegionService, setReleaseLocalService, setReleasePersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPermissionLocalService, setResourceBlockPermissionPersistence, setResourceBlockPersistence, setResourceBlockService, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService, setServiceComponentLocalService, setServiceComponentPersistence, setShardLocalService, setShardPersistence, setStagingLocalService, setStagingService, setSubscriptionLocalService, setSubscriptionPersistence, setSystemEventLocalService, setSystemEventPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setThemeLocalService, setThemeService, setTicketLocalService, setTicketPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, setUserGroupService, setUserIdMapperLocalService, setUserIdMapperPersistence, setUserLocalService, setUserNotificationDeliveryLocalService, setUserNotificationDeliveryPersistence, setUserNotificationEventLocalService, setUserNotificationEventPersistence, setUserPersistence, setUserService, setUserTrackerLocalService, setUserTrackerPathLocalService, setUserTrackerPathPersistence, setUserTrackerPersistence, setVirtualHostLocalService, setVirtualHostPersistence, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWebsiteLocalService, setWebsitePersistence, setWebsiteService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence, updateCompany

Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl

getClassLoader, getLayoutURL, getLayoutURL

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 com.liferay.portal.model.Company addCompany(java.lang.String webId,
                                          java.lang.String virtualHostname,
                                          java.lang.String mx,
                                          java.lang.String shardName,
                                          boolean system,
                                          int maxUsers,
                                          boolean active)
                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                   com.liferay.portal.kernel.exception.SystemException

Adds a company.

Parameters:

webId - the the company's web domain

virtualHostname - the company's virtual host name

mx - the company's mail domain

shardName - the company's shard

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:

com.liferay.portal.kernel.exception.PortalException - if the web domain, virtual host name, or mail domain was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

checkCompany

public com.liferay.portal.model.Company checkCompany(java.lang.String webId)
                                              throws com.liferay.portal.kernel.exception.PortalException,
                                                     com.liferay.portal.kernel.exception.SystemException

Returns the company with the web domain. The method sets mail domain to the web domain, and the shard name to the default name set in portal.properties

Parameters:

webId - the company's web domain

Returns:

the company with the web domain

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

checkCompany

public com.liferay.portal.model.Company checkCompany(java.lang.String webId,
                                            java.lang.String mx,
                                            java.lang.String shardName)
                                              throws com.liferay.portal.kernel.exception.PortalException,
                                                     com.liferay.portal.kernel.exception.SystemException

Returns the company with the web domain, mail domain, and shard. 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

shardName - the company's shard

Returns:

the company with the web domain, mail domain, and shard

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

checkCompanyKey

public void checkCompanyKey(long companyId)
                     throws com.liferay.portal.kernel.exception.PortalException,
                            com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - if a company with the primary key could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteCompany

public com.liferay.portal.model.Company deleteCompany(long companyId)
                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                      com.liferay.portal.kernel.exception.SystemException

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 com.liferay.portal.service.CompanyLocalService

Overrides:

deleteCompany in class CompanyLocalServiceBaseImpl

Parameters:

companyId - the primary key of the company

Returns:

the company that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a company with the primary key could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteLogo

public void deleteLogo(long companyId)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException

Deletes the company's logo.

Parameters:

companyId - the primary key of the company

Throws:

com.liferay.portal.kernel.exception.PortalException - if the company with the primary key could not be found or if the company's logo could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

fetchCompanyById

public com.liferay.portal.model.Company fetchCompanyById(long companyId)
                                                  throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

fetchCompanyByVirtualHost

public com.liferay.portal.model.Company fetchCompanyByVirtualHost(java.lang.String virtualHostname)
                                                           throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanies

public java.util.List<com.liferay.portal.model.Company> getCompanies()
                                                              throws com.liferay.portal.kernel.exception.SystemException

Returns all the companies.

Returns:

the companies

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanies

public java.util.List<com.liferay.portal.model.Company> getCompanies(boolean system)
                                                              throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompaniesCount

public int getCompaniesCount(boolean system)
                      throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanyById

public com.liferay.portal.model.Company getCompanyById(long companyId)
                                                throws com.liferay.portal.kernel.exception.PortalException,
                                                       com.liferay.portal.kernel.exception.SystemException

Returns the company with the primary key.

Parameters:

companyId - the primary key of the company

Returns:

the company with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException - if a company with the primary key could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanyByLogoId

public com.liferay.portal.model.Company getCompanyByLogoId(long logoId)
                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                           com.liferay.portal.kernel.exception.SystemException

Returns the company with the logo.

Parameters:

logoId - the ID of the company's logo

Returns:

the company with the logo

Throws:

com.liferay.portal.kernel.exception.PortalException - if the company with the logo could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanyByMx

public com.liferay.portal.model.Company getCompanyByMx(java.lang.String mx)
                                                throws com.liferay.portal.kernel.exception.PortalException,
                                                       com.liferay.portal.kernel.exception.SystemException

Returns the company with the mail domain.

Parameters:

mx - the company's mail domain

Returns:

the company with the mail domain

Throws:

com.liferay.portal.kernel.exception.PortalException - if the company with the mail domain could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanyByVirtualHost

public com.liferay.portal.model.Company getCompanyByVirtualHost(java.lang.String virtualHostname)
                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - if the company with the virtual host name could not be found or if the virtual host was not associated with a company

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanyByWebId

public com.liferay.portal.model.Company getCompanyByWebId(java.lang.String webId)
                                                   throws com.liferay.portal.kernel.exception.PortalException,
                                                          com.liferay.portal.kernel.exception.SystemException

Returns the company with the web domain.

Parameters:

webId - the company's web domain

Returns:

the company with the web domain

Throws:

com.liferay.portal.kernel.exception.PortalException - if the company with the web domain could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getCompanyIdByUserId

public long getCompanyIdByUserId(long userId)
                          throws java.lang.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:

java.lang.Exception - if a user with the primary key could not be found

removePreferences

public void removePreferences(long companyId,
                     java.lang.String[] keys)
                       throws com.liferay.portal.kernel.exception.SystemException

Removes the values that match the keys of the company's preferences. This method is called by 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.SystemException - if a system exception occurred

search

public com.liferay.portal.kernel.search.Hits search(long companyId,
                                           long userId,
                                           java.lang.String keywords,
                                           int start,
                                           int end)
                                             throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

search

public com.liferay.portal.kernel.search.Hits search(long companyId,
                                           long userId,
                                           java.lang.String portletId,
                                           long groupId,
                                           java.lang.String type,
                                           java.lang.String keywords,
                                           int start,
                                           int end)
                                             throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateCompany

public com.liferay.portal.model.Company updateCompany(long companyId,
                                             java.lang.String virtualHostname,
                                             java.lang.String mx,
                                             int maxUsers,
                                             boolean active)
                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                      com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - if a company with primary key could not be found or if the new information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateCompany

public com.liferay.portal.model.Company updateCompany(long companyId,
                                             java.lang.String virtualHostname,
                                             java.lang.String mx,
                                             java.lang.String homeURL,
                                             java.lang.String name,
                                             java.lang.String legalName,
                                             java.lang.String legalId,
                                             java.lang.String legalType,
                                             java.lang.String sicCode,
                                             java.lang.String tickerSymbol,
                                             java.lang.String industry,
                                             java.lang.String type,
                                             java.lang.String size)
                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                      com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - if a company with the primary key could not be found or if the new information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateDisplay

public void updateDisplay(long companyId,
                 java.lang.String languageId,
                 java.lang.String timeZoneId)
                   throws com.liferay.portal.kernel.exception.PortalException,
                          com.liferay.portal.kernel.exception.SystemException

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 - if the company's default user could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateLogo

public com.liferay.portal.model.Company updateLogo(long companyId,
                                          byte[] bytes)
                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                   com.liferay.portal.kernel.exception.SystemException

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 - if the company's logo ID could not be found or if the logo's image was corrupted

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateLogo

public com.liferay.portal.model.Company updateLogo(long companyId,
                                          java.io.File file)
                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                   com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - the company's logo ID could not be found or if the logo's image was corrupted

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateLogo

public com.liferay.portal.model.Company updateLogo(long companyId,
                                          java.io.InputStream is)
                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                   com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - if the company's logo ID could not be found or if the company's logo image was corrupted

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updatePreferences

public void updatePreferences(long companyId,
                     com.liferay.portal.kernel.util.UnicodeProperties properties)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException

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:

com.liferay.portal.kernel.exception.PortalException - if the properties contained new locales that were not supported

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateSecurity

public void updateSecurity(long companyId,
                  java.lang.String authType,
                  boolean autoLogin,
                  boolean sendPassword,
                  boolean strangers,
                  boolean strangersWithMx,
                  boolean strangersVerify,
                  boolean siteLogo)
                    throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

checkLogo

protected com.liferay.portal.model.Company checkLogo(long companyId)
                                              throws com.liferay.portal.kernel.exception.PortalException,
                                                     com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

doDeleteCompany

protected com.liferay.portal.model.Company doDeleteCompany(long companyId)
                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                           com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updateAccount

protected void updateAccount(com.liferay.portal.model.Company company,
                 java.lang.String name,
                 java.lang.String legalName,
                 java.lang.String legalId,
                 java.lang.String legalType,
                 java.lang.String sicCode,
                 java.lang.String tickerSymbol,
                 java.lang.String industry,
                 java.lang.String type,
                 java.lang.String size)
                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

updateVirtualHostname

protected void updateVirtualHostname(long companyId,
                         java.lang.String virtualHostname)
                              throws com.liferay.portal.CompanyVirtualHostException,
                                     com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.CompanyVirtualHostException

com.liferay.portal.kernel.exception.SystemException

validateLanguageIds

protected void validateLanguageIds(java.lang.String languageIds)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

validateMx

protected void validateMx(java.lang.String mx)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

validateName

protected void validateName(long companyId,
                java.lang.String name)
                     throws com.liferay.portal.kernel.exception.PortalException,
                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

validateVirtualHost

protected void validateVirtualHost(java.lang.String webId,
                       java.lang.String virtualHostname)
                            throws com.liferay.portal.kernel.exception.PortalException,
                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException