|
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.CompanyServiceUtil
public class CompanyServiceUtil
The utility for the company remote service. This utility wraps com.liferay.portal.service.impl.CompanyServiceImpl
and is the primary access point for service operations in application layer code running on a remote server.
This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
CompanyService
,
CompanyServiceBaseImpl
,
com.liferay.portal.service.impl.CompanyServiceImpl
Constructor Summary | |
---|---|
CompanyServiceUtil()
|
Method Summary | |
---|---|
static Company |
addCompany(String webId,
String virtualHost,
String mx,
String shardName,
boolean system,
int maxUsers,
boolean active)
Adds a company. |
static void |
deleteLogo(long companyId)
Deletes the company's logo. |
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
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 CompanyService |
getService()
|
static void |
removePreferences(long companyId,
String[] keys)
Removes the values that match the keys of the company's preferences. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(CompanyService service)
Deprecated. |
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,
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,
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,
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CompanyServiceUtil()
Method Detail |
---|
public static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static Company addCompany(String webId, String virtualHost, String mx, String shardName, boolean system, int maxUsers, boolean active) throws PortalException, SystemException
webId
- the company's web domainvirtualHost
- 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., themaxUsers
- 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 or if the user was not a universal
administrator
SystemException
- if a system exception occurredpublic static 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 or if the user
was not an administrator
SystemException
- if a system exception occurredpublic static 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 static 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 static 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 static Company getCompanyByVirtualHost(String virtualHost) throws PortalException, SystemException
virtualHost
- 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 static 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 static void removePreferences(long companyId, String[] keys) throws PortalException, SystemException
com.liferay.portlet.portalsettings.action.EditLDAPServerAction
remotely
through CompanyService
.
companyId
- the primary key of the companykeys
- the company's preferences keys to be remove
PortalException
- if the user was not an administrator
SystemException
- if a system exception occurredpublic static Company updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) throws PortalException, SystemException
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 active
PortalException
- if a company with the primary key could not be
found or if the new information was invalid or if the user was
not a universal administrator
SystemException
- if a system exception occurredpublic static Company 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 PortalException, SystemException
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
)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
)
PortalException
- if a company with the primary key could not be
found or if the new information was invalid or if the user was
not an administrator
SystemException
- if a system exception occurredpublic static Company 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, String languageId, String timeZoneId, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, UnicodeProperties properties) throws PortalException, SystemException
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
)name
- 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 properties
PortalException
- the company with the primary key could not be
found or if the new information was invalid or if the user was
not an administrator
SystemException
- if a system exception occurredpublic static 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
or if the user was not an administrator
SystemException
- if a system exception occurredpublic static Company updateLogo(long companyId, InputStream inputStream) throws PortalException, SystemException
companyId
- the primary key of the companyinputStream
- the input stream 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 or if the user was an
administrator
SystemException
- if a system exception occurredpublic static 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 user was not an administrator
SystemException
- if a system exception occurredpublic static void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo) throws PortalException, 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 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
PortalException
- if the user was not an administrator
SystemException
- if a system exception occurredpublic static CompanyService getService()
public void setService(CompanyService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |