com.liferay.portal.service
Class CompanyServiceWrapper

java.lang.Object
  com.liferay.portal.service.CompanyServiceWrapper

All Implemented Interfaces:

BaseService, CompanyService, ServiceWrapper<CompanyService>

public class CompanyServiceWrapper
extends Object
implements CompanyService, ServiceWrapper<CompanyService>

This class is a wrapper for CompanyService.

See Also:

CompanyService

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

CompanyServiceWrapper(CompanyService companyService)

Method Summary

Company	addCompany(String webId, String virtualHost, String mx, String shardName, boolean system, int maxUsers, boolean active) Adds a company.
void	deleteLogo(long companyId) Deletes the company's logo.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 domian.
Company	getCompanyByVirtualHost(String virtualHost) Returns the company with the virtual host name.
Company	getCompanyByWebId(String webId) Returns the company with the web domain.
CompanyService	getWrappedCompanyService() Deprecated. Renamed to getWrappedService()
CompanyService	getWrappedService()
void	removePreferences(long companyId, String[] keys) Removes the values that match the keys of the company's preferences.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setWrappedCompanyService(CompanyService companyService) Deprecated. Renamed to setWrappedService(com.liferay.portal.service.CompanyService)
void	setWrappedService(CompanyService companyService)
Company	updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) Updates the company
Company	updateCompany(long companyId, String virtualHost, String mx, String homeURL, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) Updates the company with additional account information.
Company	updateCompany(long companyId, String virtualHost, String mx, String homeURL, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size, String languageId, String timeZoneId, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, UnicodeProperties properties) Updates the company with addition information.
void	updateDisplay(long companyId, String languageId, String timeZoneId) Update the company's display.
Company	updateLogo(long companyId, InputStream inputStream) Updates 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompanyServiceWrapper

public CompanyServiceWrapper(CompanyService companyService)

Method Detail

getBeanIdentifier

public String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface CompanyService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface CompanyService

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCompany

public Company addCompany(String webId,
                          String virtualHost,
                          String mx,
                          String shardName,
                          boolean system,
                          int maxUsers,
                          boolean active)
                   throws PortalException,
                          SystemException

Adds a company.

Specified by:

addCompany in interface CompanyService

Parameters:

webId - the company's web domain

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

maxUsers - the max number of company users (optionally 0)

active - whether the company is active

Returns:

the company

Throws:

PortalException - if the web domain, virtual host name, or mail domain was invalid or if the user was not a universal administrator

SystemException - if a system exception occurred

deleteLogo

public void deleteLogo(long companyId)
                throws PortalException,
                       SystemException

Deletes the company's logo.

Specified by:

deleteLogo in interface CompanyService

Parameters:

companyId - the primary key of the company

Throws:

PortalException - if the company with the primary key could not be found or if the company's logo could not be found or if the user was not an administrator

SystemException - if a system exception occurred

getCompanyById

public Company getCompanyById(long companyId)
                       throws PortalException,
                              SystemException

Returns the company with the primary key.

Specified by:

getCompanyById in interface CompanyService

Parameters:

companyId - the primary key of the company

Returns:

Returns the company with the primary key

Throws:

PortalException - if a company with the primary key could not be found

SystemException - if a system exception occurred

getCompanyByLogoId

public Company getCompanyByLogoId(long logoId)
                           throws PortalException,
                                  SystemException

Returns the company with the logo.

Specified by:

getCompanyByLogoId in interface CompanyService

Parameters:

logoId - the ID of the company's logo

Returns:

Returns the company with the logo

Throws:

PortalException - if the company with the logo could not be found

SystemException - if a system exception occurred

getCompanyByMx

public Company getCompanyByMx(String mx)
                       throws PortalException,
                              SystemException

Returns the company with the mail domian.

Specified by:

getCompanyByMx in interface CompanyService

Parameters:

mx - the company's mail domain

Returns:

Returns the company with the mail domain

Throws:

PortalException - if the company with the mail domain could not be found

SystemException - if a system exception occurred

getCompanyByVirtualHost

public Company getCompanyByVirtualHost(String virtualHost)
                                throws PortalException,
                                       SystemException

Returns the company with the virtual host name.

Specified by:

getCompanyByVirtualHost in interface CompanyService

Parameters:

virtualHost - the company's virtual host name

Returns:

Returns the company with the virtual host name

Throws:

PortalException - if the company with the virtual host name could not be found or if the virtual host was not associated with a company

SystemException - if a system exception occurred

getCompanyByWebId

public Company getCompanyByWebId(String webId)
                          throws PortalException,
                                 SystemException

Returns the company with the web domain.

Specified by:

getCompanyByWebId in interface CompanyService

Parameters:

webId - the company's web domain

Returns:

Returns the company with the web domain

Throws:

PortalException - if the company with the web domain could not be found

SystemException - if a system exception occurred

removePreferences

public void removePreferences(long companyId,
                              String[] keys)
                       throws PortalException,
                              SystemException

Removes the values that match the keys of the company's preferences. This method is called by EditLDAPServerAction remotely through CompanyService.

Specified by:

removePreferences in interface CompanyService

Parameters:

companyId - the primary key of the company

keys - the company's preferences keys to be remove

Throws:

PortalException - if the user was not an administrator

SystemException - if a system exception occurred

updateCompany

public Company updateCompany(long companyId,
                             String virtualHost,
                             String mx,
                             int maxUsers,
                             boolean active)
                      throws PortalException,
                             SystemException

Updates the company

Specified by:

updateCompany in interface CompanyService

Parameters:

companyId - the primary key of the company

virtualHost - the company's virtual host name

mx - the company's mail domain

maxUsers - the max number of company users (optionally 0)

active - whether the company is active

Returns:

the company with the primary key

Throws:

PortalException - if a company with the primary key could not be found or if the new information was invalid or if the user was not a universal administrator

SystemException - if a system exception occurred

updateCompany

public Company updateCompany(long companyId,
                             String virtualHost,
                             String mx,
                             String homeURL,
                             String name,
                             String legalName,
                             String legalId,
                             String legalType,
                             String sicCode,
                             String tickerSymbol,
                             String industry,
                             String type,
                             String size)
                      throws PortalException,
                             SystemException

Updates the company with additional account information.

Specified by:

updateCompany in interface CompanyService

Parameters:

companyId - the primary key of the company

virtualHost - the company's virtual host name

mx - the company's mail domain

homeURL - the company's home URL (optionally null)

name - the company's account name (optionally null)

legalName - the company's account legal name (optionally null)

legalId - the company's account legal ID (optionally null)

legalType - the company's account legal type (optionally null)

sicCode - the company's account SIC code (optionally null)

tickerSymbol - the company's account ticker symbol (optionally null)

industry - the the company's account industry (optionally null)

type - the company's account type (optionally null)

size - the company's account size (optionally null)

Returns:

the the company with the primary key

Throws:

PortalException - if a company with the primary key could not be found or if the new information was invalid or if the user was not an administrator

SystemException - if a system exception occurred

updateCompany

public Company updateCompany(long companyId,
                             String virtualHost,
                             String mx,
                             String homeURL,
                             String name,
                             String legalName,
                             String legalId,
                             String legalType,
                             String sicCode,
                             String tickerSymbol,
                             String industry,
                             String type,
                             String size,
                             String languageId,
                             String timeZoneId,
                             List<Address> addresses,
                             List<EmailAddress> emailAddresses,
                             List<Phone> phones,
                             List<Website> websites,
                             UnicodeProperties properties)
                      throws PortalException,
                             SystemException

Updates the company with addition information.

Specified by:

updateCompany in interface CompanyService

Parameters:

companyId - the primary key of the company

virtualHost - the company's virtual host name

mx - the company's mail domain

homeURL - the company's home URL (optionally null)

name - the company's account name (optionally null)

legalName - the company's account legal name (optionally null)

legalId - the company's accout legal ID (optionally null)

legalType - the company's account legal type (optionally null)

sicCode - the company's account SIC code (optionally null)

tickerSymbol - the company's account ticker symbol (optionally null)

industry - the the company's account industry (optionally null)

type - the company's account type (optionally null)

size - the company's account size (optionally null)

languageId - the ID of the company's default user's language

timeZoneId - the ID of the company's default user's time zone

addresses - the company's addresses

emailAddresses - the company's email addresses

phones - the company's phone numbers

websites - the company's websites

properties - the company's properties

Returns:

the company with the primary key

Throws:

PortalException - the company with the primary key could not be found or if the new information was invalid or if the user was not an administrator

SystemException - if a system exception occurred

updateDisplay

public void updateDisplay(long companyId,
                          String languageId,
                          String timeZoneId)
                   throws PortalException,
                          SystemException

Update the company's display.

Specified by:

updateDisplay in interface CompanyService

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

SystemException - if a system exception occurred

updateLogo

public Company updateLogo(long companyId,
                          InputStream inputStream)
                   throws PortalException,
                          SystemException

Updates the company's logo.

Specified by:

updateLogo in interface CompanyService

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

SystemException - if a system exception occurred

updatePreferences

public void updatePreferences(long companyId,
                              UnicodeProperties properties)
                       throws PortalException,
                              SystemException

Updates the company's preferences. The company's default properties are found in portal.properties.

Specified by:

updatePreferences in interface CompanyService

Parameters:

companyId - the primary key of the company

properties - the company's properties. See UnicodeProperties

Throws:

PortalException - if the user was not an administrator

SystemException - if a system exception occurred

updateSecurity

public void updateSecurity(long companyId,
                           String authType,
                           boolean autoLogin,
                           boolean sendPassword,
                           boolean strangers,
                           boolean strangersWithMx,
                           boolean strangersVerify,
                           boolean siteLogo)
                    throws PortalException,
                           SystemException

Updates the company's security properties.

Specified by:

updateSecurity in interface CompanyService

Parameters:

companyId - the primary key of the company

authType - the company's method of authenticating users

autoLogin - whether to allow users to select the "remember me" feature

sendPassword - whether to allow users to ask the company to send their passwords

strangers - whether to allow strangers to create accounts to register themselves in the company

strangersWithMx - whether to allow strangers to create accounts with email addresses that match the company mail suffix

strangersVerify - whether to require strangers who create accounts to be verified via email

siteLogo - whether to to allow site administrators to use their own logo instead of the enterprise logo

Throws:

PortalException - if the user was not an administrator

SystemException - if a system exception occurred

getWrappedCompanyService

public CompanyService getWrappedCompanyService()

Deprecated. Renamed to getWrappedService()

setWrappedCompanyService

public void setWrappedCompanyService(CompanyService companyService)

Deprecated. Renamed to setWrappedService(com.liferay.portal.service.CompanyService)

getWrappedService

public CompanyService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<CompanyService>

setWrappedService

public void setWrappedService(CompanyService companyService)

Specified by:

setWrappedService in interface ServiceWrapper<CompanyService>