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