Interface CompanyLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
CompanyLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddCompany
(Company company) Adds the company to the database.addCompany
(Long companyId, String webId, String virtualHostname, String mx, int maxUsers, boolean active, boolean addDefaultAdminUser, String defaultAdminPassword, String defaultAdminScreenName, String defaultAdminEmailAddress, String defaultAdminFirstName, String defaultAdminMiddleName, String defaultAdminLastName) Adds a company with the primary key.addDBPartitionCompany
(long companyId, String name, String virtualHostname, String webId) checkCompany
(String webId) Returns the company with the web domain.void
checkCompanyKey
(long companyId) Checks if the company has an encryption key.copyDBPartitionCompany
(long fromCompanyId, Long toCompanyId, String name, String virtualHostname, String webId) createCompany
(long companyId) Creates a new company with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteCompany
(long companyId) Deletes the company with the primary key from the database.deleteCompany
(Company company) Deletes the company from the database.deleteLogo
(long companyId) Deletes the company's logo.deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.extractDBPartitionCompany
(long companyId) fetchCompany
(long companyId) fetchCompanyById
(long companyId) Returns the company with the primary key.fetchCompanyByVirtualHost
(String virtualHostname) Returns the company with the virtual host name.<E extends Exception>
voidforEachCompany
(com.liferay.petra.function.UnsafeConsumer<Company, E> unsafeConsumer) <E extends Exception>
voidforEachCompany
(com.liferay.petra.function.UnsafeConsumer<Company, E> unsafeConsumer, List<Company> companies) <E extends Exception>
voidforEachCompanyId
(com.liferay.petra.function.UnsafeConsumer<Long, E> unsafeConsumer) <E extends Exception>
voidforEachCompanyId
(com.liferay.petra.function.UnsafeConsumer<Long, E> unsafeConsumer, long[] companyIds) Returns all the companies.getCompanies
(int start, int end) Returns a range of all the companies.int
Returns the number of companies.getCompany
(long companyId) Returns the company with the primary key.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 domain.getCompanyByVirtualHost
(String virtualHostname) Returns the company with the virtual host name.getCompanyByWebId
(String webId) Returns the company with the web domain.long
getCompanyIdByUserId
(long userId) Returns the user's company.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) void
removePreferences
(long companyId, String[] keys) Removes the values that match the keys of the company's preferences.Returns an ordered range of all assets that match the keywords in the company.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.updateCompany
(long companyId, String virtualHostname, String mx, int maxUsers, boolean active) Updates the 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.updateCompany
(Company company) Updates the company in the database or adds it if it does not yet exist.void
updateDisplay
(long companyId, String languageId, String timeZoneId) Update the company's display.void
updateDisplayGroupNames
(long companyId) updateIndexNameNext
(long companyId, String indexNameNext) updateIndexNames
(long companyId, String indexNameCurrent, String indexNameNext) updateLogo
(long companyId, byte[] bytes) Updates the company's logo.updateLogo
(long companyId, File file) Updates the company's logo.updateLogo
(long companyId, InputStream inputStream) Update 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.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addCompany
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
Company addCompany(Long companyId, String webId, String virtualHostname, String mx, int maxUsers, boolean active, boolean addDefaultAdminUser, String defaultAdminPassword, String defaultAdminScreenName, String defaultAdminEmailAddress, String defaultAdminFirstName, String defaultAdminMiddleName, String defaultAdminLastName) throws PortalException Adds a company with the primary key.- Parameters:
companyId
- the primary key of the company (optionallynull
or0
to generate a key automatically)webId
- the the company's web domainvirtualHostname
- 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
-
addDBPartitionCompany
Company addDBPartitionCompany(long companyId, String name, String virtualHostname, String webId) throws PortalException - Throws:
PortalException
-
checkCompany
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
-
checkCompanyKey
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
-
copyDBPartitionCompany
Company copyDBPartitionCompany(long fromCompanyId, Long toCompanyId, String name, String virtualHostname, String webId) throws PortalException - Throws:
PortalException
-
createCompany
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
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteCompany
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
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
Deletes the company's logo.- Parameters:
companyId
- the primary key of the company- Returns:
- the deleted logo's company
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.CompanyModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.CompanyModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
extractDBPartitionCompany
- Throws:
PortalException
-
fetchCompany
-
fetchCompanyById
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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(enabled=false) <E extends Exception> void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company, E> unsafeConsumer) throws E- Throws:
E extends Exception
-
forEachCompany
@Transactional(enabled=false) <E extends Exception> void forEachCompany(com.liferay.petra.function.UnsafeConsumer<Company, E> unsafeConsumer, List<Company> companies) throws E- Throws:
E extends Exception
-
forEachCompanyId
@Transactional(enabled=false) <E extends Exception> void forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long, E> unsafeConsumer) throws E- Throws:
E extends Exception
-
forEachCompanyId
@Transactional(enabled=false) <E extends Exception> void forEachCompanyId(com.liferay.petra.function.UnsafeConsumer<Long, E> unsafeConsumer, long[] companyIds) throws E- Throws:
E extends Exception
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getCompanies
Returns all the companies.- Returns:
- the companies
-
getCompanies
Returns a range of all the companies.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.CompanyModelImpl
.- Parameters:
start
- the lower bound of the range of companiesend
- the upper bound of the range of companies (not inclusive)- Returns:
- the range of companies
-
getCompaniesCount
Returns the number of companies.- Returns:
- the number of companies
-
getCompany
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@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:
- 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:
- 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 domain.- Parameters:
mx
- the company's mail domain- Returns:
- the company with the mail domain
- Throws:
PortalException
-
getCompanyByVirtualHost
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@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:
- the company with the web domain
- Throws:
PortalException
-
getCompanyIdByUserId
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
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
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) 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 incom.liferay.portal.search.PortalOpenSearchImpl
which is not longer used by the Search portlet.- Parameters:
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 (optionallynull
)start
- the lower bound of the range of assets to returnend
- the upper bound of the range of assets to return (not inclusive)- Returns:
- the matching assets in the company
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) 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 companyuserId
- the primary key of the userportletId
- the primary key of the portlet (optionallynull
)groupId
- the primary key of the group (optionally0
)type
- the mime type of assets to return(optionallynull
)keywords
- the keywords (space separated), which may occur in any assets in the portlet (optionallynull
)start
- the lower bound of the range of assets to returnend
- the upper bound of the range of assets to return (not inclusive)- Returns:
- the matching assets in the portlet within the company
-
updateCompany
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
Company updateCompany(long companyId, String virtualHostname, String mx, int maxUsers, boolean active) throws PortalException Updates the company.- Parameters:
companyId
- the primary key of the companyvirtualHostname
- 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 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 companyvirtualHostname
- 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 company's account industry (optionallynull
)type
- the company's account type (optionallynull
)size
- the company's account size (optionallynull
)- 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
-
updateDisplayGroupNames
- Throws:
PortalException
-
updateIndexNameNext
- Throws:
PortalException
-
updateIndexNames
Company updateIndexNames(long companyId, String indexNameCurrent, String indexNameNext) throws PortalException - 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
Updates the company's logo.- Parameters:
companyId
- the primary key of the companyfile
- the file of the company's logo image- Returns:
- the company with the primary key
- Throws:
PortalException
-
updateLogo
Update 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
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 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
-