com.liferay.portal.kernel.service

Class CompanyLocalServiceUtil

Object

com.liferay.portal.kernel.service.CompanyLocalServiceUtil

public class CompanyLocalServiceUtil
extends Object

Provides the local service utility for Company. This utility wraps com.liferay.portal.service.impl.CompanyLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

CompanyLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
CompanyLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Company	addCompany(Company company) Adds the company to the database.
static Company	addCompany(Long companyId, String webId, String virtualHostname, String mx, boolean system, int maxUsers, boolean active) Adds a company with the primary key.
static Company	addCompany(String webId, String virtualHostname, String mx, boolean system, int maxUsers, boolean active) Deprecated. As of Athanasius (7.3.x), replaced by addCompany(Long, String, String, String, boolean, int, boolean)
static Company	checkCompany(String webId) Returns the company with the web domain.
static Company	checkCompany(String webId, String mx) Returns the company with the web domain and mail domain.
static void	checkCompanyKey(long companyId) Checks if the company has an encryption key.
static Company	createCompany(long companyId) Creates a new company with the primary key.
static PersistedModel	createPersistedModel(Serializable primaryKeyObj)
static Company	deleteCompany(Company company) Deletes the company from the database.
static Company	deleteCompany(long companyId) Deletes the company with the primary key from the database.
static Company	deleteLogo(long companyId) Deletes the company's logo.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Company	fetchCompany(long companyId)
static Company	fetchCompanyById(long companyId) Returns the company with the primary key.
static Company	fetchCompanyByVirtualHost(String virtualHostname) Returns the company with the virtual host name.
static <E extends Exception> void	forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company,E> unsafeConsumer)
static <E extends Exception> void	forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company,E> unsafeConsumer, List<Company> companies)
static <E extends Exception> void	forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long,E> unsafeConsumer)
static <E extends Exception> void	forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long,E> unsafeConsumer, long[] companyIds)
static ActionableDynamicQuery	getActionableDynamicQuery()
static List<Company>	getCompanies() Returns all the companies.
static List<Company>	getCompanies(boolean system) Returns all the companies used by WSRP.
static List<Company>	getCompanies(boolean system, int start, int end)
static List<Company>	getCompanies(int start, int end) Returns a range of all the companies.
static int	getCompaniesCount() Returns the number of companies.
static int	getCompaniesCount(boolean system) Returns the number of companies used by WSRP.
static Company	getCompany(long companyId) Returns the company with the primary key.
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 domain.
static Company	getCompanyByVirtualHost(String virtualHostname) Returns the company with the virtual host name.
static Company	getCompanyByWebId(String webId) Returns the company with the web domain.
static long	getCompanyIdByUserId(long userId) Returns the user's company.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static CompanyLocalService	getService()
static void	removePreferences(long companyId, String[] keys) Removes the values that match the keys of the company's preferences.
static 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.
static 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.
static Company	updateCompany(Company company) Updates the company in the database or adds it if it does not yet exist.
static Company	updateCompany(long companyId, String virtualHostname, String mx, int maxUsers, boolean active) Updates the company.
static Company	updateCompany(long companyId, String virtualHostname, 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) Update the company with additional account information.
static void	updateDisplay(long companyId, String languageId, String timeZoneId) Update the company's display.
static void	updateDisplayGroupNames(long companyId)
static Company	updateLogo(long companyId, byte[] bytes) Updates the company's logo.
static Company	updateLogo(long companyId, File file) Updates the company's logo.
static Company	updateLogo(long companyId, InputStream inputStream) Update the company's logo.
static void	updatePreferences(long companyId, UnicodeProperties unicodeProperties) 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompanyLocalServiceUtil

public CompanyLocalServiceUtil()

Method Detail

addCompany

public static Company addCompany(Company company)

Adds the company to the database. Also notifies the appropriate model listeners.

Important: Inspect CompanyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

company - the company

Returns:

the company that was added

addCompany

public static Company addCompany(Long companyId,
                                 String webId,
                                 String virtualHostname,
                                 String mx,
                                 boolean system,
                                 int maxUsers,
                                 boolean active)
                          throws PortalException

Adds a company with the primary key.

Parameters:

companyId - the primary key of the company (optionally null or 0 to generate a key automatically)

webId - the the company's web domain

virtualHostname - the company's virtual host name

mx - the company's mail domain

system - 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

Returns:

the company

Throws:

PortalException

addCompany

@Deprecated
public static Company addCompany(String webId,
                                             String virtualHostname,
                                             String mx,
                                             boolean system,
                                             int maxUsers,
                                             boolean active)
                                      throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by addCompany(Long, String, String, String, boolean, int, boolean)

Adds a company.

Parameters:

webId - the the company's web domain

virtualHostname - the company's virtual host name

mx - the company's mail domain

system - 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

Returns:

the company

Throws:

PortalException

checkCompany

public static Company checkCompany(String webId)
                            throws PortalException

Returns the company with the web domain. The method sets mail domain to the web domain to the default name set in portal.properties

Parameters:

webId - the company's web domain

Returns:

the company with the web domain

Throws:

PortalException

checkCompany

public static Company checkCompany(String webId,
                                   String mx)
                            throws PortalException

Returns the company with the web domain and mail domain. The method goes through a series of checks to ensure that the company contains default users, groups, etc.

Parameters:

webId - the company's web domain

mx - the company's mail domain

Returns:

the company with the web domain and mail domain

Throws:

PortalException

checkCompanyKey

public static void checkCompanyKey(long companyId)
                            throws PortalException

Checks if the company has an encryption key. It will create a key if one does not exist.

Parameters:

companyId - the primary key of the company

Throws:

PortalException

createCompany

public static Company createCompany(long companyId)

Creates a new company with the primary key. Does not add the company to the database.

Parameters:

companyId - the primary key for the new company

Returns:

the new company

createPersistedModel

public static PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteCompany

public static Company deleteCompany(Company company)
                             throws PortalException

Deletes the company from the database. Also notifies the appropriate model listeners.

Important: Inspect CompanyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

company - the company

Returns:

the company that was removed

Throws:

PortalException

deleteCompany

public static Company deleteCompany(long companyId)
                             throws PortalException

Deletes the company with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect CompanyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

companyId - the primary key of the company

Returns:

the company that was removed

Throws:

PortalException - if a company with the primary key could not be found

deleteLogo

public static Company deleteLogo(long companyId)
                          throws PortalException

Deletes the company's logo.

Parameters:

companyId - the primary key of the company

Returns:

the deleted logo's company

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.CompanyModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.CompanyModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchCompany

public static Company fetchCompany(long companyId)

fetchCompanyById

public static Company fetchCompanyById(long companyId)

Returns the company with the primary key.

Parameters:

companyId - the primary key of the company

Returns:

the company with the primary key, null if a company with the primary key could not be found

fetchCompanyByVirtualHost

public static Company fetchCompanyByVirtualHost(String virtualHostname)

Returns the company with the virtual host name.

Parameters:

virtualHostname - the virtual host name

Returns:

the company with the virtual host name, null if a company with the virtual host could not be found

forEachCompany

public static <E extends Exception> void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company,E> unsafeConsumer)
                                                 throws E extends Exception

Throws:

E extends Exception

forEachCompany

public static <E extends Exception> void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company,E> unsafeConsumer,
                                                        List<Company> companies)
                                                 throws E extends Exception

Throws:

E extends Exception

forEachCompanyId

public static <E extends Exception> void forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long,E> unsafeConsumer)
                                                   throws E extends Exception

Throws:

E extends Exception

forEachCompanyId

public static <E extends Exception> void forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long,E> unsafeConsumer,
                                                          long[] companyIds)
                                                   throws E extends Exception

Throws:

E extends Exception

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCompanies

public static List<Company> getCompanies()

Returns all the companies.

Returns:

the companies

getCompanies

public static List<Company> getCompanies(boolean system)

Returns all the companies used by WSRP.

Parameters:

system - whether the company is the very first company (i.e., the super company)

Returns:

the companies used by WSRP

getCompanies

public static List<Company> getCompanies(boolean system,
                                         int start,
                                         int end)

getCompanies

public static List<Company> getCompanies(int start,
                                         int end)

Returns a range of all the companies.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.CompanyModelImpl.

Parameters:

start - the lower bound of the range of companies

end - the upper bound of the range of companies (not inclusive)

Returns:

the range of companies

getCompaniesCount

public static int getCompaniesCount()

Returns the number of companies.

Returns:

the number of companies

getCompaniesCount

public static int getCompaniesCount(boolean system)

Returns the number of companies used by WSRP.

Parameters:

system - whether the company is the very first company (i.e., the super company)

Returns:

the number of companies used by WSRP

getCompany

public static Company getCompany(long companyId)
                          throws PortalException

Returns the company with the primary key.

Parameters:

companyId - the primary key of the company

Returns:

the company

Throws:

PortalException - if a company with the primary key could not be found

getCompanyById

public static Company getCompanyById(long companyId)
                              throws PortalException

Returns the company with the primary key.

Parameters:

companyId - the primary key of the company

Returns:

the company with the primary key

Throws:

PortalException

getCompanyByLogoId

public static Company getCompanyByLogoId(long logoId)
                                  throws PortalException

Returns the company with the logo.

Parameters:

logoId - the ID of the company's logo

Returns:

the company with the logo

Throws:

PortalException

getCompanyByMx

public static Company getCompanyByMx(String mx)
                              throws PortalException

Returns the company with the mail domain.

Parameters:

mx - the company's mail domain

Returns:

the company with the mail domain

Throws:

PortalException

getCompanyByVirtualHost

public static Company getCompanyByVirtualHost(String virtualHostname)
                                       throws PortalException

Returns the company with the virtual host name.

Parameters:

virtualHostname - the company's virtual host name

Returns:

the company with the virtual host name

Throws:

PortalException

getCompanyByWebId

public static Company getCompanyByWebId(String webId)
                                 throws PortalException

Returns the company with the web domain.

Parameters:

webId - the company's web domain

Returns:

the company with the web domain

Throws:

PortalException

getCompanyIdByUserId

public static long getCompanyIdByUserId(long userId)
                                 throws Exception

Returns the user's company.

Parameters:

userId - the primary key of the user

Returns:

Returns the first company if there is only one company or the user's company if there are more than one company; 0 otherwise

Throws:

Exception - if a user with the primary key could not be found

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

removePreferences

public static void removePreferences(long companyId,
                                     String[] keys)

Removes the values that match the keys of the company's preferences. This method is called by com.liferay.portlet.portalsettings.action.EditLDAPServerAction remotely through CompanyService.

Parameters:

companyId - the primary key of the company

keys - the company's preferences keys to be remove

search

public static 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. The method is called in com.liferay.portal.search.PortalOpenSearchImpl which is not longer used by the Search portlet.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

keywords - the keywords (space separated),which may occur in assets in the company (optionally null)

start - the lower bound of the range of assets to return

end - the upper bound of the range of assets to return (not inclusive)

Returns:

the matching assets in the company

search

public static 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.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

portletId - 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 return

end - the upper bound of the range of assets to return (not inclusive)

Returns:

the matching assets in the portlet within the company

updateCompany

public static Company updateCompany(Company company)

Updates the company in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect CompanyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

company - the company

Returns:

the company that was updated

updateCompany

public static Company updateCompany(long companyId,
                                    String virtualHostname,
                                    String mx,
                                    int maxUsers,
                                    boolean active)
                             throws PortalException

Updates the company.

Parameters:

companyId - the primary key of the company

virtualHostname - the company's virtual host name

mx - the company's mail domain

maxUsers - the max number of company users (optionally 0)

active - whether the company is active

Returns:

the company with the primary key

Throws:

PortalException

updateCompany

public static Company updateCompany(long companyId,
                                    String virtualHostname,
                                    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

Update the company with additional account information.

Parameters:

companyId - the primary key of the company

virtualHostname - the company's virtual host name

mx - the company's mail domain

homeURL - the company's home URL (optionally null)

hasLogo - if the company has a custom logo

logoBytes - the new logo image data

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)

Returns:

the company with the primary key

Throws:

PortalException

updateDisplay

public static void updateDisplay(long companyId,
                                 String languageId,
                                 String timeZoneId)
                          throws PortalException

Update the company's display.

Parameters:

companyId - the primary key of the company

languageId - the ID of the company's default user's language

timeZoneId - the ID of the company's default user's time zone

Throws:

PortalException

updateDisplayGroupNames

public static void updateDisplayGroupNames(long companyId)
                                    throws PortalException

Throws:

PortalException

updateLogo

public static Company updateLogo(long companyId,
                                 byte[] bytes)
                          throws PortalException

Updates the company's logo.

Parameters:

companyId - the primary key of the company

bytes - the bytes of the company's logo image

Returns:

the company with the primary key

Throws:

PortalException

updateLogo

public static Company updateLogo(long companyId,
                                 File file)
                          throws PortalException

Updates the company's logo.

Parameters:

companyId - the primary key of the company

file - the file of the company's logo image

Returns:

the company with the primary key

Throws:

PortalException

updateLogo

public static Company updateLogo(long companyId,
                                 InputStream inputStream)
                          throws PortalException

Update the company's logo.

Parameters:

companyId - the primary key of the company

inputStream - the input stream of the company's logo image

Returns:

the company with the primary key

Throws:

PortalException

updatePreferences

public static void updatePreferences(long companyId,
                                     UnicodeProperties unicodeProperties)
                              throws PortalException

Updates the company's preferences. The company's default properties are found in portal.properties.

Parameters:

companyId - the primary key of the company

unicodeProperties - the company's properties. See UnicodeProperties

Throws:

PortalException

updateSecurity

public 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.

Parameters:

companyId - the primary key of the company

authType - the company's method of authenticating users

autoLogin - whether to allow users to select the "remember me" feature

sendPassword - whether to allow users to ask the company to send their password

strangers - whether to allow strangers to create accounts register themselves in the company

strangersWithMx - whether to allow strangers to create accounts with email addresses that match the company mail suffix

strangersVerify - whether to require strangers who create accounts to be verified via email

siteLogo - whether to allow site administrators to use their own logo instead of the enterprise logo

getService

public static CompanyLocalService getService()