public class CompanyServiceUtil
extends Object
com.liferay.portal.service.impl.CompanyServiceImpl and is an
access point for service operations in application layer code running on a
remote server. Methods of this service are expected to have security checks
based on the propagated JAAS credentials because this service can be
accessed remotely.CompanyService| Constructor and Description |
|---|
CompanyServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static Company |
addCompany(String webId,
String virtualHost,
String mx,
boolean system,
int maxUsers,
boolean active)
Adds a company.
|
static Company |
deleteCompany(long companyId) |
static void |
deleteLogo(long companyId)
Deletes the company's logo.
|
static List<Company> |
getCompanies()
Returns all the companies.
|
static Company |
getCompanyById(long companyId)
Returns the company with the primary key.
|
static Company |
getCompanyByLogoId(long logoId)
Returns the company with the logo.
|
static Company |
getCompanyByMx(String mx)
Returns the company with the mail domian.
|
static Company |
getCompanyByVirtualHost(String virtualHost)
Returns the company with the virtual host name.
|
static Company |
getCompanyByWebId(String webId)
Returns the company with the web domain.
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static CompanyService |
getService() |
static void |
removePreferences(long companyId,
String[] keys)
Removes the values that match the keys of the company's preferences.
|
static Company |
updateCompany(long companyId,
String virtualHost,
String mx,
int maxUsers,
boolean active)
Updates the company
|
static Company |
updateCompany(long companyId,
String virtualHost,
String mx,
String homeURL,
boolean hasLogo,
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 Company |
updateCompany(long companyId,
String virtualHost,
String mx,
String homeURL,
boolean hasLogo,
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.
|
static void |
updateDisplay(long companyId,
String languageId,
String timeZoneId)
Update the company's display.
|
static Company |
updateLogo(long companyId,
byte[] bytes)
Updates the company's logo.
|
static Company |
updateLogo(long companyId,
InputStream inputStream)
Updates the company's logo.
|
static void |
updatePreferences(long companyId,
UnicodeProperties properties)
Updates the company's preferences.
|
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.
|
public static Company addCompany(String webId, String virtualHost, String mx, boolean system, int maxUsers, boolean active) throws PortalException
webId - the company's web domainvirtualHost - the company's virtual host namemx - the company's mail domainsystem - whether the company is the very first company (i.e., themaxUsers - the max number of company users (optionally
0)active - whether the company is activePortalExceptionpublic static Company deleteCompany(long companyId) throws PortalException
PortalExceptionpublic static void deleteLogo(long companyId)
throws PortalException
companyId - the primary key of the companyPortalExceptionpublic static List<Company> getCompanies()
public static Company getCompanyById(long companyId) throws PortalException
companyId - the primary key of the companyPortalExceptionpublic static Company getCompanyByLogoId(long logoId) throws PortalException
logoId - the ID of the company's logoPortalExceptionpublic static Company getCompanyByMx(String mx) throws PortalException
mx - the company's mail domainPortalExceptionpublic static Company getCompanyByVirtualHost(String virtualHost) throws PortalException
virtualHost - the company's virtual host namePortalExceptionpublic static Company getCompanyByWebId(String webId) throws PortalException
webId - the company's web domainPortalExceptionpublic static String getOSGiServiceIdentifier()
public static void removePreferences(long companyId,
String[] keys)
throws PortalException
com.liferay.portlet.portalsettings.action.EditLDAPServerAction remotely
through CompanyService.companyId - the primary key of the companykeys - the company's preferences keys to be removePortalExceptionpublic static Company updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) throws PortalException
companyId - the primary key of the companyvirtualHost - the company's virtual host namemx - the company's mail domainmaxUsers - the max number of company users (optionally
0)active - whether the company is activePortalExceptionpublic static Company updateCompany(long companyId, String virtualHost, String mx, String homeURL, boolean hasLogo, byte[] logoBytes, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) throws PortalException
companyId - the primary key of the companyvirtualHost - the company's virtual host namemx - the company's mail domainhomeURL - the company's home URL (optionally null)hasLogo - if the company has a custom logologoBytes - the new logo image dataname - 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)PortalExceptionpublic static Company updateCompany(long companyId, String virtualHost, String mx, String homeURL, boolean hasLogo, 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
companyId - the primary key of the companyvirtualHost - the company's virtual host namemx - the company's mail domainhomeURL - the company's home URL (optionally null)hasLogo - if the company has a custom logologoBytes - the new logo image dataname - 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 languagetimeZoneId - the ID of the company's default user's time zoneaddresses - the company's addressesemailAddresses - the company's email addressesphones - the company's phone numberswebsites - the company's websitesproperties - the company's propertiesPortalExceptionpublic static void updateDisplay(long companyId,
String languageId,
String timeZoneId)
throws PortalException
companyId - the primary key of the companylanguageId - the ID of the company's default user's languagetimeZoneId - the ID of the company's default user's time zonePortalExceptionpublic static Company updateLogo(long companyId, byte[] bytes) throws PortalException
companyId - the primary key of the companybytes - the bytes of the company's logo imagePortalExceptionpublic static Company updateLogo(long companyId, InputStream inputStream) throws PortalException
companyId - the primary key of the companyinputStream - the input stream of the company's logo imagePortalExceptionpublic static void updatePreferences(long companyId,
UnicodeProperties properties)
throws PortalException
companyId - the primary key of the companyproperties - the company's properties. See UnicodePropertiesPortalExceptionpublic static void updateSecurity(long companyId,
String authType,
boolean autoLogin,
boolean sendPassword,
boolean strangers,
boolean strangersWithMx,
boolean strangersVerify,
boolean siteLogo)
throws PortalException
companyId - the primary key of the companyauthType - the company's method of authenticating usersautoLogin - whether to allow users to select the "remember me"
featuresendPassword - whether to allow users to ask the company to send
their passwordsstrangers - whether to allow strangers to create accounts to
register themselves in the companystrangersWithMx - whether to allow strangers to create accounts with
email addresses that match the company mail suffixstrangersVerify - whether to require strangers who create accounts
to be verified via emailsiteLogo - whether to to allow site administrators to use their own
logo instead of the enterprise logoPortalExceptionpublic static CompanyService getService()