Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface CompanyLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
CompanyLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface CompanyLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the company local service.

This is a local service. 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.

See Also:
CompanyLocalServiceUtil, CompanyLocalServiceBaseImpl, com.liferay.portal.service.impl.CompanyLocalServiceImpl

Method Summary
 Company addCompany(Company company)
          Adds the company to the database.
 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.
 Company createCompany(long companyId)
          Creates a new company with the primary key.
 Company deleteCompany(Company company)
          Deletes the company from the database.
 Company deleteCompany(long companyId)
          Deletes the company with the primary key from the database.
 void deleteLogo(long companyId)
          Deletes the company's logo.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 Company fetchCompany(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.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<Company> getCompanies()
          Returns all the companies.
 List<Company> getCompanies(boolean system)
          Returns all the companies used by WSRP.
 List<Company> getCompanies(int start, int end)
          Returns a range of all the companies.
 int getCompaniesCount()
          Returns the number of companies.
 int getCompaniesCount(boolean system)
          Returns the number of companies used by WSRP.
 Company getCompany(long companyId)
          Returns the company with the primary key.
 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.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 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.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 Company updateCompany(Company company)
          Updates the company in the database or adds it if it does not yet exist.
 Company updateCompany(Company company, boolean merge)
          Updates the company in the database or adds it if it does not yet exist.
 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.
 

Method Detail

addCompany

Company addCompany(Company company)
                   throws SystemException
Adds the company to the database. Also notifies the appropriate model listeners.

Parameters:
company - the company
Returns:
the company that was added
Throws:
SystemException - if a system exception occurred

createCompany

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

deleteCompany

Company deleteCompany(long companyId)
                      throws PortalException,
                             SystemException
Deletes the company with the primary key from the database. Also notifies the appropriate model listeners.

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
SystemException - if a system exception occurred

deleteCompany

Company deleteCompany(Company company)
                      throws SystemException
Deletes the company from the database. Also notifies the appropriate model listeners.

Parameters:
company - the company
Returns:
the company that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchCompany

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company fetchCompany(long companyId)
                     throws SystemException
Throws:
SystemException

getCompany

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompany(long companyId)
                   throws PortalException,
                          SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getCompanies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Company> getCompanies(int start,
                                                                    int end)
                           throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

getCompaniesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompaniesCount()
                      throws SystemException
Returns the number of companies.

Returns:
the number of companies
Throws:
SystemException - if a system exception occurred

updateCompany

Company updateCompany(Company company)
                      throws SystemException
Updates the company in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
company - the company
Returns:
the company that was updated
Throws:
SystemException - if a system exception occurred

updateCompany

Company updateCompany(Company company,
                      boolean merge)
                      throws SystemException
Updates the company in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
company - the company
merge - whether to merge the company with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the company that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addCompany

Company addCompany(String webId,
                   String virtualHostname,
                   String mx,
                   String shardName,
                   boolean system,
                   int maxUsers,
                   boolean active)
                   throws PortalException,
                          SystemException
Adds a company.

Parameters:
webId - the the company's web domain
virtualHostname - the company's virtual host name
mx - the company's mail domain
shardName - the company's shard
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 - if the web domain, virtual host name, or mail domain was invalid
SystemException - if a system exception occurred

checkCompany

Company checkCompany(String webId)
                     throws PortalException,
                            SystemException
Returns the company with the web domain. The method sets mail domain to the web domain, and the shard name to the default name set in portal.properties

Parameters:
webId - the company's web domain
Returns:
the company with the web domain
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

checkCompany

Company checkCompany(String webId,
                     String mx,
                     String shardName)
                     throws PortalException,
                            SystemException
Returns the company with the web domain, mail domain, and shard. If no such company exits, the method will create a new company. 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
shardName - the company's shard
Returns:
the company with the web domain, mail domain, and shard
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

checkCompanyKey

void checkCompanyKey(long companyId)
                     throws PortalException,
                            SystemException
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 - if a company with the primary key could not be found
SystemException - if a system exception occurred

deleteLogo

void deleteLogo(long companyId)
                throws PortalException,
                       SystemException
Deletes the company's logo.

Parameters:
companyId - the primary key of the company
Throws:
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 occurred

fetchCompanyById

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company fetchCompanyById(long companyId)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

fetchCompanyByVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company fetchCompanyByVirtualHost(String virtualHostname)
                                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

getCompanies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Company> getCompanies()
                           throws SystemException
Returns all the companies.

Returns:
the companies
Throws:
SystemException - if a system exception occurred

getCompanies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Company> getCompanies(boolean system)
                           throws SystemException
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
Throws:
SystemException - if a system exception occurred

getCompaniesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompaniesCount(boolean system)
                      throws SystemException
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
Throws:
SystemException - if a system exception occurred

getCompanyById

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyById(long companyId)
                       throws PortalException,
                              SystemException
Returns the company with the primary key.

Parameters:
companyId - the primary key of the company
Returns:
the company with the primary key
Throws:
PortalException - if a company with the primary key could not be found
SystemException - if a system exception occurred

getCompanyByLogoId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByLogoId(long logoId)
                           throws PortalException,
                                  SystemException
Returns the company with the logo.

Parameters:
logoId - the ID of the company's logo
Returns:
the company with the logo
Throws:
PortalException - if the company with the logo could not be found
SystemException - if a system exception occurred

getCompanyByMx

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByMx(String mx)
                       throws PortalException,
                              SystemException
Returns the company with the mail domain.

Parameters:
mx - the company's mail domain
Returns:
the company with the mail domain
Throws:
PortalException - if the company with the mail domain could not be found
SystemException - if a system exception occurred

getCompanyByVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByVirtualHost(String virtualHostname)
                                throws PortalException,
                                       SystemException
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 - 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 occurred

getCompanyByWebId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Company getCompanyByWebId(String webId)
                          throws PortalException,
                                 SystemException
Returns the company with the web domain.

Parameters:
webId - the company's web domain
Returns:
the company with the web domain
Throws:
PortalException - if the company with the web domain could not be found
SystemException - if a system exception occurred

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

removePreferences

void removePreferences(long companyId,
                       String[] keys)
                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                     long userId,
                                                     String keywords,
                                                     int start,
                                                     int end)
            throws SystemException
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
Throws:
SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                     long userId,
                                                     String portletId,
                                                     long groupId,
                                                     String type,
                                                     String keywords,
                                                     int start,
                                                     int end)
            throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateCompany

Company updateCompany(long companyId,
                      String virtualHostname,
                      String mx,
                      int maxUsers,
                      boolean active)
                      throws PortalException,
                             SystemException
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 - if a company with primary key could not be found or if the new information was invalid
SystemException - if a system exception occurred

updateCompany

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
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)
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 - if a company with the primary key could not be found or if the new information was invalid
SystemException - if a system exception occurred

updateDisplay

void updateDisplay(long companyId,
                   String languageId,
                   String timeZoneId)
                   throws PortalException,
                          SystemException
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 - if the company's default user could not be found
SystemException - if a system exception occurred

updateLogo

Company updateLogo(long companyId,
                   byte[] bytes)
                   throws PortalException,
                          SystemException
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 - if the company's logo ID could not be found or if the logo's image was corrupted
SystemException - if a system exception occurred

updateLogo

Company updateLogo(long companyId,
                   File file)
                   throws PortalException,
                          SystemException
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 - the company's logo ID could not be found or if the logo's image was corrupted
SystemException - if a system exception occurred

updateLogo

Company updateLogo(long companyId,
                   InputStream is)
                   throws PortalException,
                          SystemException
Update the company's logo.

Parameters:
companyId - the primary key of the company
is - the input stream of the company's logo image
Returns:
the company with the primary key
Throws:
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 occurred

updatePreferences

void updatePreferences(long companyId,
                       UnicodeProperties properties)
                       throws PortalException,
                              SystemException
Updates the company's preferences. The company's default properties are found in portal.properties.

Parameters:
companyId - the primary key of the company
properties - the company's properties. See UnicodeProperties
Throws:
PortalException - if the properties contained new locales that were not supported
SystemException - if a system exception occurred

updateSecurity

void updateSecurity(long companyId,
                    String authType,
                    boolean autoLogin,
                    boolean sendPassword,
                    boolean strangers,
                    boolean strangersWithMx,
                    boolean strangersVerify,
                    boolean siteLogo)
                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3