Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface CompanyService

All Superinterfaces:
BaseService
All Known Implementing Classes:
CompanyServiceWrapper

@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface CompanyService
extends BaseService

The interface for the company remote service.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:
CompanyServiceUtil, CompanyServiceBaseImpl, com.liferay.portal.service.impl.CompanyServiceImpl

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

Method Detail

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addCompany

Company addCompany(String webId,
                   String virtualHost,
                   String mx,
                   String shardName,
                   boolean system,
                   int maxUsers,
                   boolean active)
                   throws PortalException,
                          SystemException
Adds a company.

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

void deleteLogo(long companyId)
                throws PortalException,
                       SystemException
Deletes the company's logo.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyById(long companyId)
                       throws PortalException,
                              SystemException
Returns the company with the primary key.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByLogoId(long logoId)
                           throws PortalException,
                                  SystemException
Returns the company with the logo.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByMx(String mx)
                       throws PortalException,
                              SystemException
Returns the company with the mail domian.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByVirtualHost(String virtualHost)
                                throws PortalException,
                                       SystemException
Returns the company with the virtual host name.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByWebId(String webId)
                          throws PortalException,
                                 SystemException
Returns the company with the web domain.

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

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 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
Throws:
PortalException - if the user was not an administrator
SystemException - if a system exception occurred

updateCompany

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

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

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.

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

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.

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

void updateDisplay(long companyId,
                   String languageId,
                   String timeZoneId)
                   throws PortalException,
                          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:
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

Company updateLogo(long companyId,
                   InputStream inputStream)
                   throws PortalException,
                          SystemException
Updates the company's logo.

Parameters:
companyId - the primary key of the company
inputStream - the input stream of the company's logo image
Returns:
the company with the primary key
Throws:
PortalException - 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

void updatePreferences(long companyId,
                       UnicodeProperties properties)
                       throws PortalException,
                              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:
PortalException - if the user was not an administrator
SystemException - if a system exception occurred

updateSecurity

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.

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

Liferay 6.1.2-ce-ga3