001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the company local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link CompanyLocalServiceUtil} to access the company local service. Add custom service methods to {@link com.liferay.portal.service.impl.CompanyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see CompanyLocalServiceUtil
036     * @see com.liferay.portal.service.base.CompanyLocalServiceBaseImpl
037     * @see com.liferay.portal.service.impl.CompanyLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface CompanyLocalService {
043            /**
044            * Adds the company to the database. Also notifies the appropriate model listeners.
045            *
046            * @param company the company to add
047            * @return the company that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portal.model.Company addCompany(
051                    com.liferay.portal.model.Company company)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new company with the primary key. Does not add the company to the database.
056            *
057            * @param companyId the primary key for the new company
058            * @return the new company
059            */
060            public com.liferay.portal.model.Company createCompany(long companyId);
061    
062            /**
063            * Deletes the company with the primary key from the database. Also notifies the appropriate model listeners.
064            *
065            * @param companyId the primary key of the company to delete
066            * @throws PortalException if a company with the primary key could not be found
067            * @throws SystemException if a system exception occurred
068            */
069            public void deleteCompany(long companyId)
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            /**
074            * Deletes the company from the database. Also notifies the appropriate model listeners.
075            *
076            * @param company the company to delete
077            * @throws SystemException if a system exception occurred
078            */
079            public void deleteCompany(com.liferay.portal.model.Company company)
080                    throws com.liferay.portal.kernel.exception.SystemException;
081    
082            /**
083            * Performs a dynamic query on the database and returns the matching rows.
084            *
085            * @param dynamicQuery the dynamic query to search with
086            * @return the matching rows
087            * @throws SystemException if a system exception occurred
088            */
089            @SuppressWarnings("rawtypes")
090            public java.util.List dynamicQuery(
091                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            /**
095            * Performs a dynamic query on the database and returns a range of the matching rows.
096            *
097            * <p>
098            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
099            * </p>
100            *
101            * @param dynamicQuery the dynamic query to search with
102            * @param start the lower bound of the range of model instances to return
103            * @param end the upper bound of the range of model instances to return (not inclusive)
104            * @return the range of matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
110                    int end) throws com.liferay.portal.kernel.exception.SystemException;
111    
112            /**
113            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
114            *
115            * <p>
116            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query to search with
120            * @param start the lower bound of the range of model instances to return
121            * @param end the upper bound of the range of model instances to return (not inclusive)
122            * @param orderByComparator the comparator to order the results by
123            * @return the ordered range of matching rows
124            * @throws SystemException if a system exception occurred
125            */
126            @SuppressWarnings("rawtypes")
127            public java.util.List dynamicQuery(
128                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129                    int end,
130                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
131                    throws com.liferay.portal.kernel.exception.SystemException;
132    
133            /**
134            * Counts the number of rows that match the dynamic query.
135            *
136            * @param dynamicQuery the dynamic query to search with
137            * @return the number of rows that match the dynamic query
138            * @throws SystemException if a system exception occurred
139            */
140            public long dynamicQueryCount(
141                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Gets the company with the primary key.
146            *
147            * @param companyId the primary key of the company to get
148            * @return the company
149            * @throws PortalException if a company with the primary key could not be found
150            * @throws SystemException if a system exception occurred
151            */
152            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
153            public com.liferay.portal.model.Company getCompany(long companyId)
154                    throws com.liferay.portal.kernel.exception.PortalException,
155                            com.liferay.portal.kernel.exception.SystemException;
156    
157            /**
158            * Gets a range of all the companies.
159            *
160            * <p>
161            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
162            * </p>
163            *
164            * @param start the lower bound of the range of companies to return
165            * @param end the upper bound of the range of companies to return (not inclusive)
166            * @return the range of companies
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public java.util.List<com.liferay.portal.model.Company> getCompanies(
171                    int start, int end)
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Gets the number of companies.
176            *
177            * @return the number of companies
178            * @throws SystemException if a system exception occurred
179            */
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public int getCompaniesCount()
182                    throws com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Updates the company in the database. Also notifies the appropriate model listeners.
186            *
187            * @param company the company to update
188            * @return the company that was updated
189            * @throws SystemException if a system exception occurred
190            */
191            public com.liferay.portal.model.Company updateCompany(
192                    com.liferay.portal.model.Company company)
193                    throws com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Updates the company in the database. Also notifies the appropriate model listeners.
197            *
198            * @param company the company to update
199            * @param merge whether to merge the company with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
200            * @return the company that was updated
201            * @throws SystemException if a system exception occurred
202            */
203            public com.liferay.portal.model.Company updateCompany(
204                    com.liferay.portal.model.Company company, boolean merge)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            public com.liferay.portal.model.Company addCompany(java.lang.String webId,
208                    java.lang.String virtualHost, java.lang.String mx,
209                    java.lang.String shardName, boolean system, int maxUsers)
210                    throws com.liferay.portal.kernel.exception.PortalException,
211                            com.liferay.portal.kernel.exception.SystemException;
212    
213            public com.liferay.portal.model.Company checkCompany(java.lang.String webId)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException;
216    
217            public com.liferay.portal.model.Company checkCompany(
218                    java.lang.String webId, java.lang.String mx, java.lang.String shardName)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            public void checkCompanyKey(long companyId)
223                    throws com.liferay.portal.kernel.exception.PortalException,
224                            com.liferay.portal.kernel.exception.SystemException;
225    
226            public void deleteLogo(long companyId)
227                    throws com.liferay.portal.kernel.exception.PortalException,
228                            com.liferay.portal.kernel.exception.SystemException;
229    
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public java.util.List<com.liferay.portal.model.Company> getCompanies()
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public java.util.List<com.liferay.portal.model.Company> getCompanies(
236                    boolean system)
237                    throws com.liferay.portal.kernel.exception.SystemException;
238    
239            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240            public int getCompaniesCount(boolean system)
241                    throws com.liferay.portal.kernel.exception.SystemException;
242    
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public com.liferay.portal.model.Company getCompanyById(long companyId)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public com.liferay.portal.model.Company getCompanyByLogoId(long logoId)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public com.liferay.portal.model.Company getCompanyByMx(java.lang.String mx)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public com.liferay.portal.model.Company getCompanyByVirtualHost(
260                    java.lang.String virtualHost)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public com.liferay.portal.model.Company getCompanyByWebId(
266                    java.lang.String webId)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void removePreferences(long companyId, java.lang.String[] keys)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public com.liferay.portal.kernel.search.Hits search(long companyId,
275                    long userId, java.lang.String keywords, int start, int end)
276                    throws com.liferay.portal.kernel.exception.SystemException;
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public com.liferay.portal.kernel.search.Hits search(long companyId,
280                    long userId, java.lang.String portletId, long groupId,
281                    java.lang.String type, java.lang.String keywords, int start, int end)
282                    throws com.liferay.portal.kernel.exception.SystemException;
283    
284            public com.liferay.portal.model.Company updateCompany(long companyId,
285                    java.lang.String virtualHost, java.lang.String mx, int maxUsers)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public com.liferay.portal.model.Company updateCompany(long companyId,
290                    java.lang.String virtualHost, java.lang.String mx,
291                    java.lang.String homeURL, java.lang.String name,
292                    java.lang.String legalName, java.lang.String legalId,
293                    java.lang.String legalType, java.lang.String sicCode,
294                    java.lang.String tickerSymbol, java.lang.String industry,
295                    java.lang.String type, java.lang.String size)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void updateDisplay(long companyId, java.lang.String languageId,
300                    java.lang.String timeZoneId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public void updateLogo(long companyId, byte[] bytes)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            public void updateLogo(long companyId, java.io.File file)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public void updateLogo(long companyId, java.io.InputStream is)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            public void updatePreferences(long companyId,
317                    com.liferay.portal.kernel.util.UnicodeProperties properties)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            public void updateSecurity(long companyId, java.lang.String authType,
321                    boolean autoLogin, boolean sendPassword, boolean strangers,
322                    boolean strangersWithMx, boolean strangersVerify, boolean communityLogo)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    }