CompanyServiceSoap (Liferay 7.0.10 portal-impl API)

Object
- com.liferay.portal.service.http.CompanyServiceSoap

```
@ProviderType
public class CompanyServiceSoap
extends Object
```
Provides the SOAP utility for the CompanyServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for SOAP to support certain types.
ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of CompanySoap. If the method in the service utility returns a Company, that is translated to a CompanySoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

CompanyServiceHttp, CompanySoap, CompanyServiceUtil

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

CompanyServiceSoap()

Constructors
Constructor and Description
`CompanyServiceSoap()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static com.liferay.portal.kernel.model.CompanySoap`	`addCompany(String webId, String virtualHost, String mx, boolean system, int maxUsers, boolean active)` Adds a company.
`static com.liferay.portal.kernel.model.CompanySoap`	`deleteCompany(long companyId)`
`static void`	`deleteLogo(long companyId)` Deletes the company's logo.
`static com.liferay.portal.kernel.model.CompanySoap[]`	`getCompanies()` Returns all the companies.
`static com.liferay.portal.kernel.model.CompanySoap`	`getCompanyById(long companyId)` Returns the company with the primary key.
`static com.liferay.portal.kernel.model.CompanySoap`	`getCompanyByLogoId(long logoId)` Returns the company with the logo.
`static com.liferay.portal.kernel.model.CompanySoap`	`getCompanyByMx(String mx)` Returns the company with the mail domian.
`static com.liferay.portal.kernel.model.CompanySoap`	`getCompanyByVirtualHost(String virtualHost)` Returns the company with the virtual host name.
`static com.liferay.portal.kernel.model.CompanySoap`	`getCompanyByWebId(String webId)` Returns the company with the web domain.
`static void`	`removePreferences(long companyId, String[] keys)` Removes the values that match the keys of the company's preferences.
`static com.liferay.portal.kernel.model.CompanySoap`	`updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active)` Updates the company
`static com.liferay.portal.kernel.model.CompanySoap`	`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.
`static com.liferay.portal.kernel.model.CompanySoap`	`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)`
`static void`	`updateDisplay(long companyId, String languageId, String timeZoneId)` Update the company's display.
`static com.liferay.portal.kernel.model.CompanySoap`	`updateLogo(long companyId, byte[] bytes)` Updates the company's logo.
`static 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
- CompanyServiceSoap
```
public CompanyServiceSoap()
```

Method Detail

addCompany

public static com.liferay.portal.kernel.model.CompanySoap addCompany(String webId,
                                                                     String virtualHost,
                                                                     String mx,
                                                                     boolean system,
                                                                     int maxUsers,
                                                                     boolean active)
                                                              throws RemoteException

Adds a company.

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:: RemoteException

deleteCompany

public static com.liferay.portal.kernel.model.CompanySoap deleteCompany(long companyId)
                                                                 throws RemoteException

Throws:: RemoteException

deleteLogo
```
public static void deleteLogo(long companyId)
                       throws RemoteException
```
Deletes the company's logo.

Parameters:

companyId - the primary key of the company

Throws:

RemoteException

getCompanies

public static com.liferay.portal.kernel.model.CompanySoap[] getCompanies()
                                                                  throws RemoteException

Returns all the companies.

Returns:: the companies
Throws:: RemoteException

getCompanyById

public static com.liferay.portal.kernel.model.CompanySoap getCompanyById(long companyId)
                                                                  throws RemoteException

Returns the company with the primary key.

Parameters:: companyId - the primary key of the company
Returns:: Returns the company with the primary key
Throws:: RemoteException

getCompanyByLogoId

public static com.liferay.portal.kernel.model.CompanySoap getCompanyByLogoId(long logoId)
                                                                      throws RemoteException

Returns the company with the logo.

Parameters:: logoId - the ID of the company's logo
Returns:: Returns the company with the logo
Throws:: RemoteException

getCompanyByMx

public static com.liferay.portal.kernel.model.CompanySoap getCompanyByMx(String mx)
                                                                  throws RemoteException

Returns the company with the mail domian.

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

getCompanyByVirtualHost

public static com.liferay.portal.kernel.model.CompanySoap getCompanyByVirtualHost(String virtualHost)
                                                                           throws RemoteException

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:: RemoteException

getCompanyByWebId

public static com.liferay.portal.kernel.model.CompanySoap getCompanyByWebId(String webId)
                                                                     throws RemoteException

Returns the company with the web domain.

Parameters:: webId - the company's web domain
Returns:: Returns the company with the web domain
Throws:: RemoteException

removePreferences
```
public static void removePreferences(long companyId,
                                     String[] keys)
                              throws RemoteException
```
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:

RemoteException

updateCompany

public static com.liferay.portal.kernel.model.CompanySoap updateCompany(long companyId,
                                                                        String virtualHost,
                                                                        String mx,
                                                                        int maxUsers,
                                                                        boolean active)
                                                                 throws RemoteException

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:: RemoteException

updateCompany

public static com.liferay.portal.kernel.model.CompanySoap 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 RemoteException

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); 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:: RemoteException

updateCompany

@Deprecated
public static com.liferay.portal.kernel.model.CompanySoap 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 RemoteException

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.

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:: RemoteException

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

RemoteException

updateLogo

public static com.liferay.portal.kernel.model.CompanySoap updateLogo(long companyId,
                                                                     byte[] bytes)
                                                              throws RemoteException

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:: RemoteException

updateSecurity
```
public static void updateSecurity(long companyId,
                                  String authType,
                                  boolean autoLogin,
                                  boolean sendPassword,
                                  boolean strangers,
                                  boolean strangersWithMx,
                                  boolean strangersVerify,
                                  boolean siteLogo)
                           throws RemoteException
```
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:

RemoteException

Class CompanyServiceSoap

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

CompanyServiceSoap

Method Detail

addCompany

deleteCompany

deleteLogo

getCompanies

getCompanyById

getCompanyByLogoId

getCompanyByMx

getCompanyByVirtualHost

getCompanyByWebId

removePreferences

updateCompany

updateCompany

updateCompany

updateDisplay

updateLogo

updateSecurity