001 /** 002 * Copyright (c) 2000-2013 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 /** 018 * Provides a wrapper for {@link CompanyService}. 019 * 020 * @author Brian Wing Shun Chan 021 * @see CompanyService 022 * @generated 023 */ 024 public class CompanyServiceWrapper implements CompanyService, 025 ServiceWrapper<CompanyService> { 026 public CompanyServiceWrapper(CompanyService companyService) { 027 _companyService = companyService; 028 } 029 030 /** 031 * Returns the Spring bean ID for this bean. 032 * 033 * @return the Spring bean ID for this bean 034 */ 035 @Override 036 public java.lang.String getBeanIdentifier() { 037 return _companyService.getBeanIdentifier(); 038 } 039 040 /** 041 * Sets the Spring bean ID for this bean. 042 * 043 * @param beanIdentifier the Spring bean ID for this bean 044 */ 045 @Override 046 public void setBeanIdentifier(java.lang.String beanIdentifier) { 047 _companyService.setBeanIdentifier(beanIdentifier); 048 } 049 050 /** 051 * Adds a company. 052 * 053 * @param webId the company's web domain 054 * @param virtualHost the company's virtual host name 055 * @param mx the company's mail domain 056 * @param shardName the company's shard 057 * @param system whether the company is the very first company (i.e., the 058 * @param maxUsers the max number of company users (optionally 059 <code>0</code>) 060 * @param active whether the company is active 061 * @return the company 062 * @throws PortalException if the web domain, virtual host name, or mail 063 domain was invalid or if the user was not a universal 064 administrator 065 * @throws SystemException if a system exception occurred 066 */ 067 @Override 068 public com.liferay.portal.model.Company addCompany(java.lang.String webId, 069 java.lang.String virtualHost, java.lang.String mx, 070 java.lang.String shardName, boolean system, int maxUsers, boolean active) 071 throws com.liferay.portal.kernel.exception.PortalException, 072 com.liferay.portal.kernel.exception.SystemException { 073 return _companyService.addCompany(webId, virtualHost, mx, shardName, 074 system, maxUsers, active); 075 } 076 077 @Override 078 public com.liferay.portal.model.Company deleteCompany(long companyId) 079 throws com.liferay.portal.kernel.exception.PortalException, 080 com.liferay.portal.kernel.exception.SystemException { 081 return _companyService.deleteCompany(companyId); 082 } 083 084 /** 085 * Deletes the company's logo. 086 * 087 * @param companyId the primary key of the company 088 * @throws PortalException if the company with the primary key could not be 089 found or if the company's logo could not be found or if the user 090 was not an administrator 091 * @throws SystemException if a system exception occurred 092 */ 093 @Override 094 public void deleteLogo(long companyId) 095 throws com.liferay.portal.kernel.exception.PortalException, 096 com.liferay.portal.kernel.exception.SystemException { 097 _companyService.deleteLogo(companyId); 098 } 099 100 /** 101 * Returns the company with the primary key. 102 * 103 * @param companyId the primary key of the company 104 * @return Returns the company with the primary key 105 * @throws PortalException if a company with the primary key could not be 106 found 107 * @throws SystemException if a system exception occurred 108 */ 109 @Override 110 public com.liferay.portal.model.Company getCompanyById(long companyId) 111 throws com.liferay.portal.kernel.exception.PortalException, 112 com.liferay.portal.kernel.exception.SystemException { 113 return _companyService.getCompanyById(companyId); 114 } 115 116 /** 117 * Returns the company with the logo. 118 * 119 * @param logoId the ID of the company's logo 120 * @return Returns the company with the logo 121 * @throws PortalException if the company with the logo could not be found 122 * @throws SystemException if a system exception occurred 123 */ 124 @Override 125 public com.liferay.portal.model.Company getCompanyByLogoId(long logoId) 126 throws com.liferay.portal.kernel.exception.PortalException, 127 com.liferay.portal.kernel.exception.SystemException { 128 return _companyService.getCompanyByLogoId(logoId); 129 } 130 131 /** 132 * Returns the company with the mail domian. 133 * 134 * @param mx the company's mail domain 135 * @return Returns the company with the mail domain 136 * @throws PortalException if the company with the mail domain could not be 137 found 138 * @throws SystemException if a system exception occurred 139 */ 140 @Override 141 public com.liferay.portal.model.Company getCompanyByMx(java.lang.String mx) 142 throws com.liferay.portal.kernel.exception.PortalException, 143 com.liferay.portal.kernel.exception.SystemException { 144 return _companyService.getCompanyByMx(mx); 145 } 146 147 /** 148 * Returns the company with the virtual host name. 149 * 150 * @param virtualHost the company's virtual host name 151 * @return Returns the company with the virtual host name 152 * @throws PortalException if the company with the virtual host name could 153 not be found or if the virtual host was not associated with a 154 company 155 * @throws SystemException if a system exception occurred 156 */ 157 @Override 158 public com.liferay.portal.model.Company getCompanyByVirtualHost( 159 java.lang.String virtualHost) 160 throws com.liferay.portal.kernel.exception.PortalException, 161 com.liferay.portal.kernel.exception.SystemException { 162 return _companyService.getCompanyByVirtualHost(virtualHost); 163 } 164 165 /** 166 * Returns the company with the web domain. 167 * 168 * @param webId the company's web domain 169 * @return Returns the company with the web domain 170 * @throws PortalException if the company with the web domain could not be 171 found 172 * @throws SystemException if a system exception occurred 173 */ 174 @Override 175 public com.liferay.portal.model.Company getCompanyByWebId( 176 java.lang.String webId) 177 throws com.liferay.portal.kernel.exception.PortalException, 178 com.liferay.portal.kernel.exception.SystemException { 179 return _companyService.getCompanyByWebId(webId); 180 } 181 182 /** 183 * Removes the values that match the keys of the company's preferences. 184 * 185 * This method is called by {@link 186 * com.liferay.portlet.portalsettings.action.EditLDAPServerAction} remotely 187 * through {@link com.liferay.portal.service.CompanyService}. 188 * 189 * @param companyId the primary key of the company 190 * @param keys the company's preferences keys to be remove 191 * @throws PortalException if the user was not an administrator 192 * @throws SystemException if a system exception occurred 193 */ 194 @Override 195 public void removePreferences(long companyId, java.lang.String[] keys) 196 throws com.liferay.portal.kernel.exception.PortalException, 197 com.liferay.portal.kernel.exception.SystemException { 198 _companyService.removePreferences(companyId, keys); 199 } 200 201 /** 202 * Updates the company 203 * 204 * @param companyId the primary key of the company 205 * @param virtualHost the company's virtual host name 206 * @param mx the company's mail domain 207 * @param maxUsers the max number of company users (optionally 208 <code>0</code>) 209 * @param active whether the company is active 210 * @return the company with the primary key 211 * @throws PortalException if a company with the primary key could not be 212 found or if the new information was invalid or if the user was 213 not a universal administrator 214 * @throws SystemException if a system exception occurred 215 */ 216 @Override 217 public com.liferay.portal.model.Company updateCompany(long companyId, 218 java.lang.String virtualHost, java.lang.String mx, int maxUsers, 219 boolean active) 220 throws com.liferay.portal.kernel.exception.PortalException, 221 com.liferay.portal.kernel.exception.SystemException { 222 return _companyService.updateCompany(companyId, virtualHost, mx, 223 maxUsers, active); 224 } 225 226 /** 227 * Updates the company with additional account information. 228 * 229 * @param companyId the primary key of the company 230 * @param virtualHost the company's virtual host name 231 * @param mx the company's mail domain 232 * @param homeURL the company's home URL (optionally <code>null</code>) 233 * @param name the company's account name (optionally <code>null</code>) 234 * @param legalName the company's account legal name (optionally 235 <code>null</code>) 236 * @param legalId the company's account legal ID (optionally 237 <code>null</code>) 238 * @param legalType the company's account legal type (optionally 239 <code>null</code>) 240 * @param sicCode the company's account SIC code (optionally 241 <code>null</code>) 242 * @param tickerSymbol the company's account ticker symbol (optionally 243 <code>null</code>) 244 * @param industry the the company's account industry (optionally 245 <code>null</code>) 246 * @param type the company's account type (optionally <code>null</code>) 247 * @param size the company's account size (optionally <code>null</code>) 248 * @return the the company with the primary key 249 * @throws PortalException if a company with the primary key could not be 250 found or if the new information was invalid or if the user was 251 not an administrator 252 * @throws SystemException if a system exception occurred 253 */ 254 @Override 255 public com.liferay.portal.model.Company updateCompany(long companyId, 256 java.lang.String virtualHost, java.lang.String mx, 257 java.lang.String homeURL, java.lang.String name, 258 java.lang.String legalName, java.lang.String legalId, 259 java.lang.String legalType, java.lang.String sicCode, 260 java.lang.String tickerSymbol, java.lang.String industry, 261 java.lang.String type, java.lang.String size) 262 throws com.liferay.portal.kernel.exception.PortalException, 263 com.liferay.portal.kernel.exception.SystemException { 264 return _companyService.updateCompany(companyId, virtualHost, mx, 265 homeURL, name, legalName, legalId, legalType, sicCode, 266 tickerSymbol, industry, type, size); 267 } 268 269 /** 270 * Updates the company with addition information. 271 * 272 * @param companyId the primary key of the company 273 * @param virtualHost the company's virtual host name 274 * @param mx the company's mail domain 275 * @param homeURL the company's home URL (optionally <code>null</code>) 276 * @param name the company's account name (optionally <code>null</code>) 277 * @param legalName the company's account legal name (optionally 278 <code>null</code>) 279 * @param legalId the company's accout legal ID (optionally 280 <code>null</code>) 281 * @param legalType the company's account legal type (optionally 282 <code>null</code>) 283 * @param sicCode the company's account SIC code (optionally 284 <code>null</code>) 285 * @param tickerSymbol the company's account ticker symbol (optionally 286 <code>null</code>) 287 * @param industry the the company's account industry (optionally 288 <code>null</code>) 289 * @param type the company's account type (optionally <code>null</code>) 290 * @param size the company's account size (optionally <code>null</code>) 291 * @param languageId the ID of the company's default user's language 292 * @param timeZoneId the ID of the company's default user's time zone 293 * @param addresses the company's addresses 294 * @param emailAddresses the company's email addresses 295 * @param phones the company's phone numbers 296 * @param websites the company's websites 297 * @param properties the company's properties 298 * @return the company with the primary key 299 * @throws PortalException the company with the primary key could not be 300 found or if the new information was invalid or if the user was 301 not an administrator 302 * @throws SystemException if a system exception occurred 303 */ 304 @Override 305 public com.liferay.portal.model.Company updateCompany(long companyId, 306 java.lang.String virtualHost, java.lang.String mx, 307 java.lang.String homeURL, java.lang.String name, 308 java.lang.String legalName, java.lang.String legalId, 309 java.lang.String legalType, java.lang.String sicCode, 310 java.lang.String tickerSymbol, java.lang.String industry, 311 java.lang.String type, java.lang.String size, 312 java.lang.String languageId, java.lang.String timeZoneId, 313 java.util.List<com.liferay.portal.model.Address> addresses, 314 java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses, 315 java.util.List<com.liferay.portal.model.Phone> phones, 316 java.util.List<com.liferay.portal.model.Website> websites, 317 com.liferay.portal.kernel.util.UnicodeProperties properties) 318 throws com.liferay.portal.kernel.exception.PortalException, 319 com.liferay.portal.kernel.exception.SystemException { 320 return _companyService.updateCompany(companyId, virtualHost, mx, 321 homeURL, name, legalName, legalId, legalType, sicCode, 322 tickerSymbol, industry, type, size, languageId, timeZoneId, 323 addresses, emailAddresses, phones, websites, properties); 324 } 325 326 /** 327 * Update the company's display. 328 * 329 * @param companyId the primary key of the company 330 * @param languageId the ID of the company's default user's language 331 * @param timeZoneId the ID of the company's default user's time zone 332 * @throws PortalException if the company's default user could not be found 333 or if the user was not an administrator 334 * @throws SystemException if a system exception occurred 335 */ 336 @Override 337 public void updateDisplay(long companyId, java.lang.String languageId, 338 java.lang.String timeZoneId) 339 throws com.liferay.portal.kernel.exception.PortalException, 340 com.liferay.portal.kernel.exception.SystemException { 341 _companyService.updateDisplay(companyId, languageId, timeZoneId); 342 } 343 344 /** 345 * Updates the company's logo. 346 * 347 * @param companyId the primary key of the company 348 * @param bytes the bytes of the company's logo image 349 * @return the company with the primary key 350 * @throws PortalException if the company's logo ID could not be found or if 351 the logo's image was corrupted or if the user was an 352 administrator 353 * @throws SystemException if a system exception occurred 354 */ 355 @Override 356 public com.liferay.portal.model.Company updateLogo(long companyId, 357 byte[] bytes) 358 throws com.liferay.portal.kernel.exception.PortalException, 359 com.liferay.portal.kernel.exception.SystemException { 360 return _companyService.updateLogo(companyId, bytes); 361 } 362 363 /** 364 * Updates the company's logo. 365 * 366 * @param companyId the primary key of the company 367 * @param inputStream the input stream of the company's logo image 368 * @return the company with the primary key 369 * @throws PortalException if the company's logo ID could not be found or if 370 the logo's image was corrupted or if the user was an 371 administrator 372 * @throws SystemException if a system exception occurred 373 */ 374 @Override 375 public com.liferay.portal.model.Company updateLogo(long companyId, 376 java.io.InputStream inputStream) 377 throws com.liferay.portal.kernel.exception.PortalException, 378 com.liferay.portal.kernel.exception.SystemException { 379 return _companyService.updateLogo(companyId, inputStream); 380 } 381 382 /** 383 * Updates the company's preferences. The company's default properties are 384 * found in portal.properties. 385 * 386 * @param companyId the primary key of the company 387 * @param properties the company's properties. See {@link 388 com.liferay.portal.kernel.util.UnicodeProperties} 389 * @throws PortalException if the user was not an administrator 390 * @throws SystemException if a system exception occurred 391 */ 392 @Override 393 public void updatePreferences(long companyId, 394 com.liferay.portal.kernel.util.UnicodeProperties properties) 395 throws com.liferay.portal.kernel.exception.PortalException, 396 com.liferay.portal.kernel.exception.SystemException { 397 _companyService.updatePreferences(companyId, properties); 398 } 399 400 /** 401 * Updates the company's security properties. 402 * 403 * @param companyId the primary key of the company 404 * @param authType the company's method of authenticating users 405 * @param autoLogin whether to allow users to select the "remember me" 406 feature 407 * @param sendPassword whether to allow users to ask the company to send 408 their passwords 409 * @param strangers whether to allow strangers to create accounts to 410 register themselves in the company 411 * @param strangersWithMx whether to allow strangers to create accounts 412 with email addresses that match the company mail suffix 413 * @param strangersVerify whether to require strangers who create accounts 414 to be verified via email 415 * @param siteLogo whether to to allow site administrators to use their own 416 logo instead of the enterprise logo 417 * @throws PortalException if the user was not an administrator 418 * @throws SystemException if a system exception occurred 419 */ 420 @Override 421 public void updateSecurity(long companyId, java.lang.String authType, 422 boolean autoLogin, boolean sendPassword, boolean strangers, 423 boolean strangersWithMx, boolean strangersVerify, boolean siteLogo) 424 throws com.liferay.portal.kernel.exception.PortalException, 425 com.liferay.portal.kernel.exception.SystemException { 426 _companyService.updateSecurity(companyId, authType, autoLogin, 427 sendPassword, strangers, strangersWithMx, strangersVerify, siteLogo); 428 } 429 430 /** 431 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 432 */ 433 public CompanyService getWrappedCompanyService() { 434 return _companyService; 435 } 436 437 /** 438 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 439 */ 440 public void setWrappedCompanyService(CompanyService companyService) { 441 _companyService = companyService; 442 } 443 444 @Override 445 public CompanyService getWrappedService() { 446 return _companyService; 447 } 448 449 @Override 450 public void setWrappedService(CompanyService companyService) { 451 _companyService = companyService; 452 } 453 454 private CompanyService _companyService; 455 }