com.liferay.portal.kernel.service

Class CompanyServiceWrapper

Object

com.liferay.portal.kernel.service.CompanyServiceWrapper

All Implemented Interfaces:

BaseService, CompanyService, ServiceWrapper<CompanyService>

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

Provides a wrapper for CompanyService.

Author:

Brian Wing Shun Chan

See Also:

CompanyService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
CompanyServiceWrapper(CompanyService companyService)

Method Summary

Modifier and Type	Method and Description
Company	addCompany(String webId, String virtualHost, String mx, boolean system, int maxUsers, boolean active) Adds a company.
Company	deleteCompany(long companyId)
void	deleteLogo(long companyId) Deletes the company's logo.
List<Company>	getCompanies() Returns all the companies.
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.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
CompanyService	getWrappedService()
void	removePreferences(long companyId, String[] keys) Removes the values that match the keys of the company's preferences.
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, boolean logo, byte[] logoBytes, 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, boolean logo, byte[] logoBytes, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size, String languageId, String timeZoneId, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, UnicodeProperties properties) Updates the company with addition 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) Deprecated. As of Wilberforce (7.0.x), replaced by updateCompany(long, String, String, String, boolean, byte[], String, String, String, String, String, String, String, String, String)
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) Deprecated. As of Wilberforce (7.0.x), replaced by updateCompany(long, String, String, String, boolean, byte[], String, String, String, String, String, String, String, String, String, String, String, List, List, List, List, UnicodeProperties)
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, 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 Object

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

Constructor Detail

CompanyServiceWrapper

public CompanyServiceWrapper(CompanyService companyService)

Method Detail

addCompany

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

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

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

deleteCompany

public Company deleteCompany(long companyId)
                      throws PortalException

Specified by:

deleteCompany in interface CompanyService

Throws:

PortalException

deleteLogo

public void deleteLogo(long companyId)
                throws PortalException

Deletes the company's logo.

Specified by:

deleteLogo in interface CompanyService

Parameters:

companyId - the primary key of the company

Throws:

PortalException

getCompanies

public List<Company> getCompanies()

Returns all the companies.

Specified by:

getCompanies in interface CompanyService

Returns:

the companies

getCompanyById

public Company getCompanyById(long companyId)
                       throws PortalException

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

getCompanyByLogoId

public Company getCompanyByLogoId(long logoId)
                           throws PortalException

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

getCompanyByMx

public Company getCompanyByMx(String mx)
                       throws PortalException

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

getCompanyByVirtualHost

public Company getCompanyByVirtualHost(String virtualHost)
                                throws PortalException

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

getCompanyByWebId

public Company getCompanyByWebId(String webId)
                          throws PortalException

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

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface CompanyService

Returns:

the OSGi service identifier

removePreferences

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

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

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

updateCompany

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

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

updateCompany

public Company updateCompany(long companyId,
                             String virtualHost,
                             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

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)

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 the company's account industry (optionally null)

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

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

Returns:

the the company with the primary key

Throws:

PortalException

updateCompany

public Company updateCompany(long companyId,
                             String virtualHost,
                             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,
                             String languageId,
                             String timeZoneId,
                             List<Address> addresses,
                             List<EmailAddress> emailAddresses,
                             List<Phone> phones,
                             List<Website> websites,
                             UnicodeProperties properties)
                      throws PortalException

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)

logo - if the company has a custom logo

logoBytes - the new logo image data

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

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

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

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

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

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

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

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

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

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

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

addresses - the company's addresses

emailAddresses - the company's email addresses

phones - the company's phone numbers

websites - the company's websites

properties - the company's properties

Returns:

the company with the primary key

Throws:

PortalException

updateCompany

@Deprecated
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

Deprecated. As of Wilberforce (7.0.x), replaced by updateCompany(long, String, String, String, boolean, byte[], String, String, String, String, String, String, String, String, String)

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

updateCompany

@Deprecated
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

Deprecated. As of Wilberforce (7.0.x), replaced by updateCompany(long, String, String, String, boolean, byte[], String, String, String, String, String, String, String, String, String, String, String, List, List, List, List, UnicodeProperties)

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

updateDisplay

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

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

updateLogo

public Company updateLogo(long companyId,
                          byte[] bytes)
                   throws PortalException

Updates the company's logo.

Specified by:

updateLogo in interface CompanyService

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,
                          InputStream inputStream)
                   throws PortalException

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

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.

Specified by:

updatePreferences in interface CompanyService

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

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

getWrappedService

public CompanyService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<CompanyService>

setWrappedService

public void setWrappedService(CompanyService companyService)

Specified by:

setWrappedService in interface ServiceWrapper<CompanyService>