Interface CompanyService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
CompanyServiceWrapper
@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface CompanyService
extends BaseService
Provides the remote service interface for Company. Methods of this
service are expected to have security checks based on the propagated JAAS
credentials because this service can be accessed remotely.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddCompany
(long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active) Adds a company.addCompany
(Long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active, String defaultAdminPassword, String defaultAdminScreenName, String defaultAdminEmailAddress, String defaultAdminFirstName, String defaultAdminMiddleName, String defaultAdminLastName) Adds a company.deleteCompany
(long companyId) void
deleteLogo
(long companyId) Deletes the company's logo.void
forEachCompany
(com.liferay.petra.function.UnsafeConsumer<Company, Exception> unsafeConsumer) Returns all the companies.getCompanyById
(long companyId) Returns the company with the primary key.getCompanyByLogoId
(long logoId) Returns the company with the logo.getCompanyByMx
(String mx) Returns the company with the mail domian.getCompanyByVirtualHost
(String virtualHost) Returns the company with the virtual host name.getCompanyByWebId
(String webId) Returns the company with the web domain.Returns the OSGi service identifier.void
removePreferences
(long companyId, String[] keys) Removes the values that match the keys of the company's preferences.updateCompany
(long companyId, String virtualHost, String mx, int maxUsers, boolean active) Updates the companyupdateCompany
(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.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 unicodeProperties) Updates the company with addition information.void
updateDisplay
(long companyId, String languageId, String timeZoneId) Update the company's display.updateLogo
(long companyId, byte[] bytes) Updates the company's logo.updateLogo
(long companyId, InputStream inputStream) Updates the company's logo.void
updatePreferences
(long companyId, UnicodeProperties unicodeProperties) 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 Details
-
addCompany
@JSONWebService(mode=IGNORE) Company addCompany(long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active) throws PortalException Adds a company.- Parameters:
companyId
- the primary key of the company (optionallynull
or0
to generate a key automatically)webId
- the company's web domainvirtualHost
- the company's virtual host namemx
- the company's mail domainmaxUsers
- the max number of company users (optionally0
)active
- whether the company is active- Returns:
- the company
- Throws:
PortalException
-
addCompany
@JSONWebService(mode=IGNORE) Company addCompany(Long companyId, String webId, String virtualHost, String mx, int maxUsers, boolean active, String defaultAdminPassword, String defaultAdminScreenName, String defaultAdminEmailAddress, String defaultAdminFirstName, String defaultAdminMiddleName, String defaultAdminLastName) throws PortalException Adds a company.- Parameters:
webId
- the company's web domainvirtualHost
- the company's virtual host namemx
- the company's mail domainmaxUsers
- the max number of company users (optionally0
)active
- whether the company is active- Returns:
- the company
- Throws:
PortalException
-
deleteCompany
- Throws:
PortalException
-
deleteLogo
Deletes the company's logo.- Parameters:
companyId
- the primary key of the company- Throws:
PortalException
-
forEachCompany
void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company, Exception> unsafeConsumer) throws Exception- Throws:
Exception
-
getCompanies
Returns all the companies.- Returns:
- the companies
-
getCompanyById
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyById(long companyId) throws PortalException 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
-
getCompanyByLogoId
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByLogoId(long logoId) throws PortalException Returns the company with the logo.- Parameters:
logoId
- the ID of the company's logo- Returns:
- Returns the company with the logo
- Throws:
PortalException
-
getCompanyByMx
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByMx(String mx) throws PortalException Returns the company with the mail domian.- Parameters:
mx
- the company's mail domain- Returns:
- Returns the company with the mail domain
- Throws:
PortalException
-
getCompanyByVirtualHost
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByVirtualHost(String virtualHost) throws PortalException 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
-
getCompanyByWebId
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByWebId(String webId) throws PortalException Returns the company with the web domain.- Parameters:
webId
- the company's web domain- Returns:
- Returns the company with the web domain
- Throws:
PortalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
removePreferences
Removes the values that match the keys of the company's preferences. This method is called bycom.liferay.portlet.portalsettings.action.EditLDAPServerAction
remotely throughCompanyService
.- Parameters:
companyId
- the primary key of the companykeys
- the company's preferences keys to be remove- Throws:
PortalException
-
updateCompany
Company updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) throws PortalException Updates the company- Parameters:
companyId
- the primary key of the companyvirtualHost
- the company's virtual host namemx
- the company's mail domainmaxUsers
- the max number of company users (optionally0
)active
- whether the company is active- Returns:
- the company with the primary key
- Throws:
PortalException
-
updateCompany
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 Updates the company with additional account information.- Parameters:
companyId
- the primary key of the companyvirtualHost
- the company's virtual host namemx
- the company's mail domainhomeURL
- the company's home URL (optionallynull
)hasLogo
- if the company has a custom logologoBytes
- the new logo image dataname
- the company's account name (optionallynull
)legalName
- the company's account legal name (optionallynull
)legalId
- the company's account legal ID (optionallynull
)legalType
- the company's account legal type (optionallynull
)sicCode
- the company's account SIC code (optionallynull
)tickerSymbol
- the company's account ticker symbol (optionallynull
)industry
- the the company's account industry (optionallynull
)type
- the company's account type (optionallynull
)size
- the company's account size (optionallynull
)- Returns:
- the the company with the primary key
- Throws:
PortalException
-
updateCompany
@JSONWebService(mode=IGNORE) 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 unicodeProperties) throws PortalException Updates the company with addition information.- Parameters:
companyId
- the primary key of the companyvirtualHost
- the company's virtual host namemx
- the company's mail domainhomeURL
- the company's home URL (optionallynull
)hasLogo
- if the company has a custom logologoBytes
- the new logo image dataname
- the company's account name (optionallynull
)legalName
- the company's account legal name (optionallynull
)legalId
- the company's accout legal ID (optionallynull
)legalType
- the company's account legal type (optionallynull
)sicCode
- the company's account SIC code (optionallynull
)tickerSymbol
- the company's account ticker symbol (optionallynull
)industry
- the the company's account industry (optionallynull
)type
- the company's account type (optionallynull
)size
- the company's account size (optionallynull
)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 websitesunicodeProperties
- the company's properties- Returns:
- the company with the primary key
- Throws:
PortalException
-
updateDisplay
Update the company's display.- Parameters:
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 zone- Throws:
PortalException
-
updateLogo
Updates the company's logo.- Parameters:
companyId
- the primary key of the companybytes
- the bytes of the company's logo image- Returns:
- the company with the primary key
- Throws:
PortalException
-
updateLogo
@JSONWebService(mode=IGNORE) Company updateLogo(long companyId, InputStream inputStream) throws PortalException Updates the company's logo.- Parameters:
companyId
- the primary key of the companyinputStream
- the input stream of the company's logo image- Returns:
- the company with the primary key
- Throws:
PortalException
-
updatePreferences
Updates the company's preferences. The company's default properties are found in portal.properties.- Parameters:
companyId
- the primary key of the companyunicodeProperties
- the company's properties. SeeUnicodeProperties
- Throws:
PortalException
-
updateSecurity
@JSONWebService(mode=IGNORE) 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.- Parameters:
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 logo- Throws:
PortalException
-