|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portal.service.base.CompanyLocalServiceBaseImpl
com.liferay.portal.service.impl.CompanyLocalServiceImpl
public class CompanyLocalServiceImpl
Provides the local service for adding, checking, and updating companies. Each company refers to a separate portal instance.
| Nested Class Summary | |
|---|---|
protected class |
CompanyLocalServiceImpl.DeleteGroupActionableDynamicQuery
|
protected class |
CompanyLocalServiceImpl.DeleteOrganizationActionableDynamicQuery
|
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
CompanyLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
Company |
addCompany(String webId,
String virtualHostname,
String mx,
boolean system,
int maxUsers,
boolean active)
Adds a company. |
Company |
checkCompany(String webId)
Returns the company with the web domain. |
Company |
checkCompany(String webId,
String mx)
Returns the company with the web domain and mail domain. |
void |
checkCompanyKey(long companyId)
Checks if the company has an encryption key. |
protected Company |
checkLogo(long companyId)
|
Company |
deleteCompany(Company company)
Deletes the company from the database. |
Company |
deleteCompany(long companyId)
Deletes the company with the primary key from the database. |
Company |
deleteLogo(long companyId)
Deletes the company's logo. |
protected Company |
doDeleteCompany(long companyId)
|
Company |
fetchCompanyById(long companyId)
Returns the company with the primary key. |
Company |
fetchCompanyByVirtualHost(String virtualHostname)
Returns the company with the virtual host name. |
List<Company> |
getCompanies()
Returns all the companies. |
List<Company> |
getCompanies(boolean system)
Returns all the companies used by WSRP. |
List<Company> |
getCompanies(boolean system,
int start,
int end)
|
int |
getCompaniesCount(boolean system)
Returns the number of companies used by WSRP. |
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 domain. |
Company |
getCompanyByVirtualHost(String virtualHostname)
Returns the company with the virtual host name. |
Company |
getCompanyByWebId(String webId)
Returns the company with the web domain. |
long |
getCompanyIdByUserId(long userId)
Returns the user's company. |
void |
removePreferences(long companyId,
String[] keys)
Removes the values that match the keys of the company's preferences. |
Hits |
search(long companyId,
long userId,
String keywords,
int start,
int end)
Returns an ordered range of all assets that match the keywords in the company. |
Hits |
search(long companyId,
long userId,
String portletId,
long groupId,
String type,
String keywords,
int start,
int end)
Returns an ordered range of all assets that match the keywords in the portlet within the company. |
protected void |
updateAccount(Company company,
String name,
String legalName,
String legalId,
String legalType,
String sicCode,
String tickerSymbol,
String industry,
String type,
String size)
|
Company |
updateCompany(long companyId,
String virtualHostname,
String mx,
int maxUsers,
boolean active)
Updates the company. |
Company |
updateCompany(long companyId,
String virtualHostname,
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)
Update the company with additional account information. |
Company |
updateCompany(long companyId,
String virtualHostname,
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 7.0.0, replaced by updateCompany(long, String,
String, String, boolean, byte[], String, String, String,
String, String, String, String, String, String) |
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,
File file)
Updates the company's logo. |
Company |
updateLogo(long companyId,
InputStream is)
Update 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. |
protected void |
updateVirtualHostname(long companyId,
String virtualHostname)
|
protected void |
validateLanguageIds(String languageIds)
|
protected void |
validateMx(String mx)
|
protected void |
validateName(long companyId,
String name)
|
protected void |
validateVirtualHost(String webId,
String virtualHostname)
|
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLocalizationMap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public CompanyLocalServiceImpl()
| Method Detail |
|---|
public Company addCompany(String webId,
String virtualHostname,
String mx,
boolean system,
int maxUsers,
boolean active)
throws PortalException
webId - the the company's web domainvirtualHostname - the company's virtual host namemx - the company's mail domainsystem - whether the company is the very first company (i.e., the
super company)maxUsers - the max number of company users (optionally
0)active - whether the company is active
PortalException
public Company checkCompany(String webId)
throws PortalException
webId - the company's web domain
PortalException
public Company checkCompany(String webId,
String mx)
throws PortalException
webId - the company's web domainmx - the company's mail domain
PortalException
public void checkCompanyKey(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException
public Company deleteCompany(Company company)
throws PortalException
CompanyLocalServiceBaseImpl
deleteCompany in interface CompanyLocalServicedeleteCompany in class CompanyLocalServiceBaseImplcompany - the company
PortalException
public Company deleteCompany(long companyId)
throws PortalException
CompanyLocalServiceBaseImpl
deleteCompany in interface CompanyLocalServicedeleteCompany in class CompanyLocalServiceBaseImplcompanyId - the primary key of the company
PortalException - if a company with the primary key could not be found
public Company deleteLogo(long companyId)
throws PortalException
companyId - the primary key of the company
PortalExceptionpublic Company fetchCompanyById(long companyId)
companyId - the primary key of the company
null if a company
with the primary key could not be foundpublic Company fetchCompanyByVirtualHost(String virtualHostname)
virtualHostname - the virtual host name
null if a
company with the virtual host could not be foundpublic List<Company> getCompanies()
public List<Company> getCompanies(boolean system)
system - whether the company is the very first company (i.e., the
super company)
public List<Company> getCompanies(boolean system,
int start,
int end)
public int getCompaniesCount(boolean system)
system - whether the company is the very first company (i.e., the
super company)
public Company getCompanyById(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException
public Company getCompanyByLogoId(long logoId)
throws PortalException
logoId - the ID of the company's logo
PortalException
public Company getCompanyByMx(String mx)
throws PortalException
mx - the company's mail domain
PortalException
public Company getCompanyByVirtualHost(String virtualHostname)
throws PortalException
virtualHostname - the company's virtual host name
PortalException
public Company getCompanyByWebId(String webId)
throws PortalException
webId - the company's web domain
PortalException
public long getCompanyIdByUserId(long userId)
throws Exception
userId - the primary key of the user
0
otherwise
Exception - if a user with the primary key could not be found
public void removePreferences(long companyId,
String[] keys)
com.liferay.portlet.portalsettings.action.EditLDAPServerAction remotely
through CompanyService.
companyId - the primary key of the companykeys - the company's preferences keys to be remove
public Hits search(long companyId,
long userId,
String keywords,
int start,
int end)
PortalOpenSearchImpl which is not longer used
by the Search portlet.
companyId - the primary key of the companyuserId - the primary key of the userkeywords - the keywords (space separated),which may occur in assets
in the company (optionally null)start - the lower bound of the range of assets to returnend - the upper bound of the range of assets to return (not
inclusive)
public Hits search(long companyId,
long userId,
String portletId,
long groupId,
String type,
String keywords,
int start,
int end)
companyId - the primary key of the companyuserId - the primary key of the userportletId - the primary key of the portlet (optionally
null)groupId - the primary key of the group (optionally 0)type - the mime type of assets to return(optionally
null)keywords - the keywords (space separated), which may occur in any
assets in the portlet (optionally null)start - the lower bound of the range of assets to returnend - the upper bound of the range of assets to return (not
inclusive)
public Company updateCompany(long companyId,
String virtualHostname,
String mx,
int maxUsers,
boolean active)
throws PortalException
companyId - the primary key of the companyvirtualHostname - the company's virtual host namemx - the company's mail domainmaxUsers - the max number of company users (optionally
0)active - whether the company is active
PortalException
public Company updateCompany(long companyId,
String virtualHostname,
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
companyId - the primary key of the companyvirtualHostname - the company's virtual host namemx - the company's mail domainhomeURL - the company's home URL (optionally null)logo - whether to update the company's 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 company's account industry (optionally
null)type - the company's account type (optionally null)size - the company's account size (optionally null)
PortalException
@Deprecated
public Company updateCompany(long companyId,
String virtualHostname,
String mx,
String homeURL,
String name,
String legalName,
String legalId,
String legalType,
String sicCode,
String tickerSymbol,
String industry,
String type,
String size)
throws PortalException
updateCompany(long, String,
String, String, boolean, byte[], String, String, String,
String, String, String, String, String, String)
companyId - the primary key of the companyvirtualHostname - the company's virtual host namemx - the company's mail domainhomeURL - 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 company's account industry (optionally
null)type - the company's account type (optionally
null)size - the company's account size (optionally
null)
PortalException
public 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 zone
PortalException
public Company updateLogo(long companyId,
byte[] bytes)
throws PortalException
companyId - the primary key of the companybytes - the bytes of the company's logo image
PortalException
public Company updateLogo(long companyId,
File file)
throws PortalException
companyId - the primary key of the companyfile - the file of the company's logo image
PortalException
public Company updateLogo(long companyId,
InputStream is)
throws PortalException
companyId - the primary key of the companyis - the input stream of the company's logo image
PortalException
public void updatePreferences(long companyId,
UnicodeProperties properties)
throws PortalException
companyId - the primary key of the companyproperties - the company's properties. See UnicodeProperties
PortalException
public void updateSecurity(long companyId,
String authType,
boolean autoLogin,
boolean sendPassword,
boolean strangers,
boolean strangersWithMx,
boolean strangersVerify,
boolean siteLogo)
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 passwordstrangers - whether to allow strangers to create accounts 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 allow site administrators to use their own
logo instead of the enterprise logo
protected Company checkLogo(long companyId)
throws PortalException
PortalException
protected Company doDeleteCompany(long companyId)
throws PortalException
PortalException
protected void updateAccount(Company company,
String name,
String legalName,
String legalId,
String legalType,
String sicCode,
String tickerSymbol,
String industry,
String type,
String size)
protected void updateVirtualHostname(long companyId,
String virtualHostname)
throws CompanyVirtualHostException
CompanyVirtualHostException
protected void validateLanguageIds(String languageIds)
throws PortalException
PortalException
protected void validateMx(String mx)
throws PortalException
PortalException
protected void validateName(long companyId,
String name)
throws PortalException
PortalException
protected void validateVirtualHost(String webId,
String virtualHostname)
throws PortalException
PortalException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||