|
Liferay 6.1.2-ce-ga3 | |||||||||
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
The implementation of the company local service. Each company refers to a separate portal instance.
Field Summary |
---|
Constructor Summary | |
---|---|
CompanyLocalServiceImpl()
|
Method Summary | |
---|---|
Company |
addCompany(String webId,
String virtualHostname,
String mx,
String shardName,
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,
String shardName)
Returns the company with the web domain, mail domain, and shard. |
void |
checkCompanyKey(long companyId)
Checks if the company has an encryption key. |
protected Company |
checkLogo(long companyId)
|
void |
deleteLogo(long companyId)
Deletes the company's logo. |
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. |
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,
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. |
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 |
updateVirtualHost(long companyId,
String virtualHostname)
|
protected void |
validate(long companyId,
String name)
|
protected void |
validate(String webId,
String virtualHostname,
String mx)
|
protected void |
validateLocales(String locales)
|
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
---|
getClassLoader |
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, String shardName, boolean system, int maxUsers, boolean active) throws PortalException, SystemException
webId
- the the company's web domainvirtualHostname
- the company's virtual host namemx
- the company's mail domainshardName
- the company's shardsystem
- 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
- if the web domain, virtual host name, or mail
domain was invalid
SystemException
- if a system exception occurredpublic Company checkCompany(String webId) throws PortalException, SystemException
webId
- the company's web domain
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic Company checkCompany(String webId, String mx, String shardName) throws PortalException, SystemException
webId
- the company's web domainmx
- the company's mail domainshardName
- the company's shard
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void checkCompanyKey(long companyId) throws PortalException, SystemException
companyId
- the primary key of the company
PortalException
- if a company with the primary key could not be
found
SystemException
- if a system exception occurredpublic void deleteLogo(long companyId) throws PortalException, SystemException
companyId
- the primary key of the company
PortalException
- if the company with the primary key could not be
found or if the company's logo could not be found
SystemException
- if a system exception occurredpublic Company fetchCompanyById(long companyId) throws SystemException
companyId
- the primary key of the company
null
if a company
with the primary key could not be found
SystemException
- if a system exception occurredpublic Company fetchCompanyByVirtualHost(String virtualHostname) throws SystemException
virtualHostname
- the virtual host name
null
if a
company with the virtual host could not be found
SystemException
- if a system exception occurredpublic List<Company> getCompanies() throws SystemException
SystemException
- if a system exception occurredpublic List<Company> getCompanies(boolean system) throws SystemException
system
- whether the company is the very first company (i.e., the
super company)
SystemException
- if a system exception occurredpublic int getCompaniesCount(boolean system) throws SystemException
system
- whether the company is the very first company (i.e., the
super company)
SystemException
- if a system exception occurredpublic Company getCompanyById(long companyId) throws PortalException, SystemException
companyId
- the primary key of the company
PortalException
- if a company with the primary key could not be
found
SystemException
- if a system exception occurredpublic Company getCompanyByLogoId(long logoId) throws PortalException, SystemException
logoId
- the ID of the company's logo
PortalException
- if the company with the logo could not be found
SystemException
- if a system exception occurredpublic Company getCompanyByMx(String mx) throws PortalException, SystemException
mx
- the company's mail domain
PortalException
- if the company with the mail domain could not be
found
SystemException
- if a system exception occurredpublic Company getCompanyByVirtualHost(String virtualHostname) throws PortalException, SystemException
virtualHostname
- the company's virtual host name
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 occurredpublic Company getCompanyByWebId(String webId) throws PortalException, SystemException
webId
- the company's web domain
PortalException
- if the company with the web domain could not be
found
SystemException
- if a system exception occurredpublic 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 foundpublic void removePreferences(long companyId, String[] keys) throws SystemException
EditLDAPServerAction
remotely
through CompanyService
.
companyId
- the primary key of the companykeys
- the company's preferences keys to be remove
SystemException
- if a system exception occurredpublic Hits search(long companyId, long userId, String keywords, int start, int end) throws SystemException
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)
SystemException
- if a system exception occurredpublic Hits search(long companyId, long userId, String portletId, long groupId, String type, String keywords, int start, int end) throws SystemException
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)
SystemException
- if a system exception occurredpublic Company updateCompany(long companyId, String virtualHostname, String mx, int maxUsers, boolean active) throws PortalException, SystemException
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
- if a company with primary key could not be found
or if the new information was invalid
SystemException
- if a system exception occurredpublic 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, SystemException
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
- if a company with the primary key could not be
found or if the new information was invalid
SystemException
- if a system exception occurredpublic void updateDisplay(long companyId, String languageId, String timeZoneId) throws PortalException, SystemException
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
- if the company's default user could not be found
SystemException
- if a system exception occurredpublic Company updateLogo(long companyId, byte[] bytes) throws PortalException, SystemException
companyId
- the primary key of the companybytes
- the bytes of the company's logo image
PortalException
- if the company's logo ID could not be found or if
the logo's image was corrupted
SystemException
- if a system exception occurredpublic Company updateLogo(long companyId, File file) throws PortalException, SystemException
companyId
- the primary key of the companyfile
- the file of the company's logo image
PortalException
- the company's logo ID could not be found or if
the logo's image was corrupted
SystemException
- if a system exception occurredpublic Company updateLogo(long companyId, InputStream is) throws PortalException, SystemException
companyId
- the primary key of the companyis
- the input stream of the company's logo image
PortalException
- if the company's logo ID could not be found or if
the company's logo image was corrupted
SystemException
- if a system exception occurredpublic void updatePreferences(long companyId, UnicodeProperties properties) throws PortalException, SystemException
companyId
- the primary key of the companyproperties
- the company's properties. See UnicodeProperties
PortalException
- if the properties contained new locales that were
not supported
SystemException
- if a system exception occurredpublic void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo) throws SystemException
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
SystemException
- if a system exception occurredprotected Company checkLogo(long companyId) throws PortalException, SystemException
PortalException
SystemException
protected void updateAccount(Company company, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) throws SystemException
SystemException
protected void updateVirtualHost(long companyId, String virtualHostname) throws CompanyVirtualHostException, SystemException
CompanyVirtualHostException
SystemException
protected void validate(long companyId, String name) throws PortalException, SystemException
PortalException
SystemException
protected void validate(String webId, String virtualHostname, String mx) throws PortalException, SystemException
PortalException
SystemException
protected void validateLocales(String locales) throws PortalException
PortalException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |