com.liferay.portal.service.CompanyServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the remote service utility for Company. This utility wraps
* {@link com.liferay.portal.service.impl.CompanyServiceImpl} and is the
* primary access point for service operations in application layer code running
* on a remote server. Methods of this service are expected to have security
* checks based on the propagated JAAS credentials because this service can be
* accessed remotely.
*
* @author Brian Wing Shun Chan
* @see CompanyService
* @see com.liferay.portal.service.base.CompanyServiceBaseImpl
* @see com.liferay.portal.service.impl.CompanyServiceImpl
* @generated
*/
public class CompanyServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.CompanyServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
/**
* Adds a company.
*
* @param webId the company's web domain
* @param virtualHost the company's virtual host name
* @param mx the company's mail domain
* @param shardName the company's shard
* @param system whether the company is the very first company (i.e., the
* @param maxUsers the max number of company users (optionally
0)
* @param active whether the company is active
* @return the company
* @throws PortalException if the web domain, virtual host name, or mail
domain was invalid or if the user was not a universal
administrator
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company addCompany(
java.lang.String webId, java.lang.String virtualHost,
java.lang.String mx, java.lang.String shardName, boolean system,
int maxUsers, boolean active)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addCompany(webId, virtualHost, mx, shardName, system,
maxUsers, active);
}
public static com.liferay.portal.model.Company deleteCompany(long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deleteCompany(companyId);
}
/**
* Deletes the company's logo.
*
* @param 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 or if the user
was not an administrator
* @throws SystemException if a system exception occurred
*/
public static void deleteLogo(long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteLogo(companyId);
}
/**
* Returns the company with the primary key.
*
* @param companyId the primary key of the company
* @return Returns the company with the primary key
* @throws PortalException if a company with the primary key could not be
found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company getCompanyById(
long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getCompanyById(companyId);
}
/**
* Returns the company with the logo.
*
* @param logoId the ID of the company's logo
* @return Returns the company with the logo
* @throws PortalException if the company with the logo could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company getCompanyByLogoId(
long logoId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getCompanyByLogoId(logoId);
}
/**
* Returns the company with the mail domian.
*
* @param mx the company's mail domain
* @return Returns the company with the mail domain
* @throws PortalException if the company with the mail domain could not be
found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company getCompanyByMx(
java.lang.String mx)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getCompanyByMx(mx);
}
/**
* Returns the company with the virtual host name.
*
* @param virtualHost the company's virtual host name
* @return 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company getCompanyByVirtualHost(
java.lang.String virtualHost)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getCompanyByVirtualHost(virtualHost);
}
/**
* Returns the company with the web domain.
*
* @param webId the company's web domain
* @return Returns the company with the web domain
* @throws PortalException if the company with the web domain could not be
found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company getCompanyByWebId(
java.lang.String webId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getCompanyByWebId(webId);
}
/**
* Removes the values that match the keys of the company's preferences.
*
* This method is called by {@link
* com.liferay.portlet.portalsettings.action.EditLDAPServerAction} remotely
* through {@link com.liferay.portal.service.CompanyService}.
*
* @param companyId the primary key of the company
* @param keys the company's preferences keys to be remove
* @throws PortalException if the user was not an administrator
* @throws SystemException if a system exception occurred
*/
public static void removePreferences(long companyId, java.lang.String[] keys)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().removePreferences(companyId, keys);
}
/**
* Updates the company
*
* @param companyId the primary key of the company
* @param virtualHost the company's virtual host name
* @param mx the company's mail domain
* @param maxUsers the max number of company users (optionally
0)
* @param active whether the company is active
* @return 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 or if the user was
not a universal administrator
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company updateCompany(
long companyId, java.lang.String virtualHost, java.lang.String mx,
int maxUsers, boolean active)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateCompany(companyId, virtualHost, mx, maxUsers, active);
}
/**
* Updates the company with additional account information.
*
* @param companyId the primary key of the company
* @param virtualHost the company's virtual host name
* @param mx the company's mail domain
* @param homeURL the company's home URL (optionally null)
* @param name the company's account name (optionally null)
* @param legalName the company's account legal name (optionally
null)
* @param legalId the company's account legal ID (optionally
null)
* @param legalType the company's account legal type (optionally
null)
* @param sicCode the company's account SIC code (optionally
null)
* @param tickerSymbol the company's account ticker symbol (optionally
null)
* @param industry the the company's account industry (optionally
null)
* @param type the company's account type (optionally null)
* @param size the company's account size (optionally null)
* @return the 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 or if the user was
not an administrator
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company updateCompany(
long companyId, java.lang.String virtualHost, java.lang.String mx,
java.lang.String homeURL, java.lang.String name,
java.lang.String legalName, java.lang.String legalId,
java.lang.String legalType, java.lang.String sicCode,
java.lang.String tickerSymbol, java.lang.String industry,
java.lang.String type, java.lang.String size)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateCompany(companyId, virtualHost, mx, homeURL, name,
legalName, legalId, legalType, sicCode, tickerSymbol, industry,
type, size);
}
/**
* Updates the company with addition information.
*
* @param companyId the primary key of the company
* @param virtualHost the company's virtual host name
* @param mx the company's mail domain
* @param homeURL the company's home URL (optionally null)
* @param name the company's account name (optionally null)
* @param legalName the company's account legal name (optionally
null)
* @param legalId the company's accout legal ID (optionally
null)
* @param legalType the company's account legal type (optionally
null)
* @param sicCode the company's account SIC code (optionally
null)
* @param tickerSymbol the company's account ticker symbol (optionally
null)
* @param industry the the company's account industry (optionally
null)
* @param type the company's account type (optionally null)
* @param size the company's account size (optionally null)
* @param languageId the ID of the company's default user's language
* @param timeZoneId the ID of the company's default user's time zone
* @param addresses the company's addresses
* @param emailAddresses the company's email addresses
* @param phones the company's phone numbers
* @param websites the company's websites
* @param properties the company's properties
* @return the company with the primary key
* @throws PortalException the company with the primary key could not be
found or if the new information was invalid or if the user was
not an administrator
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company updateCompany(
long companyId, java.lang.String virtualHost, java.lang.String mx,
java.lang.String homeURL, java.lang.String name,
java.lang.String legalName, java.lang.String legalId,
java.lang.String legalType, java.lang.String sicCode,
java.lang.String tickerSymbol, java.lang.String industry,
java.lang.String type, java.lang.String size,
java.lang.String languageId, java.lang.String timeZoneId,
java.util.List addresses,
java.util.List emailAddresses,
java.util.List phones,
java.util.List websites,
com.liferay.portal.kernel.util.UnicodeProperties properties)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateCompany(companyId, virtualHost, mx, homeURL, name,
legalName, legalId, legalType, sicCode, tickerSymbol, industry,
type, size, languageId, timeZoneId, addresses, emailAddresses,
phones, websites, properties);
}
/**
* Update the company's display.
*
* @param companyId the primary key of the company
* @param languageId the ID of the company's default user's language
* @param timeZoneId the ID of the company's default user's time zone
* @throws PortalException if the company's default user could not be found
or if the user was not an administrator
* @throws SystemException if a system exception occurred
*/
public static void updateDisplay(long companyId,
java.lang.String languageId, java.lang.String timeZoneId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().updateDisplay(companyId, languageId, timeZoneId);
}
/**
* Updates the company's logo.
*
* @param companyId the primary key of the company
* @param bytes the bytes of the company's logo image
* @return 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 or if the user was an
administrator
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company updateLogo(long companyId,
byte[] bytes)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().updateLogo(companyId, bytes);
}
/**
* Updates the company's logo.
*
* @param companyId the primary key of the company
* @param inputStream the input stream of the company's logo image
* @return 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 or if the user was an
administrator
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Company updateLogo(long companyId,
java.io.InputStream inputStream)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().updateLogo(companyId, inputStream);
}
/**
* Updates the company's preferences. The company's default properties are
* found in portal.properties.
*
* @param companyId the primary key of the company
* @param properties the company's properties. See {@link
com.liferay.portal.kernel.util.UnicodeProperties}
* @throws PortalException if the user was not an administrator
* @throws SystemException if a system exception occurred
*/
public static void updatePreferences(long companyId,
com.liferay.portal.kernel.util.UnicodeProperties properties)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().updatePreferences(companyId, properties);
}
/**
* Updates the company's security properties.
*
* @param companyId the primary key of the company
* @param authType the company's method of authenticating users
* @param autoLogin whether to allow users to select the "remember me"
feature
* @param sendPassword whether to allow users to ask the company to send
their passwords
* @param strangers whether to allow strangers to create accounts to
register themselves in the company
* @param strangersWithMx whether to allow strangers to create accounts
with email addresses that match the company mail suffix
* @param strangersVerify whether to require strangers who create accounts
to be verified via email
* @param siteLogo whether to to allow site administrators to use their own
logo instead of the enterprise logo
* @throws PortalException if the user was not an administrator
* @throws SystemException if a system exception occurred
*/
public static void updateSecurity(long companyId,
java.lang.String authType, boolean autoLogin, boolean sendPassword,
boolean strangers, boolean strangersWithMx, boolean strangersVerify,
boolean siteLogo)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService()
.updateSecurity(companyId, authType, autoLogin, sendPassword,
strangers, strangersWithMx, strangersVerify, siteLogo);
}
public static CompanyService getService() {
if (_service == null) {
_service = (CompanyService)PortalBeanLocatorUtil.locate(CompanyService.class.getName());
ReferenceRegistry.registerReference(CompanyServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(CompanyService service) {
}
private static CompanyService _service;
}