/** * Copyright (c) 2000-present 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.dynamic.data.lists.service.http; import aQute.bnd.annotation.ProviderType; import com.liferay.dynamic.data.lists.service.DDLRecordSetServiceUtil; import com.liferay.portal.kernel.log.Log; import com.liferay.portal.kernel.log.LogFactoryUtil; import com.liferay.portal.kernel.util.LocalizationUtil; import java.rmi.RemoteException; import java.util.Locale; import java.util.Map; /** * Provides the SOAP utility for the * {@link DDLRecordSetServiceUtil} service utility. The * static methods of this class calls the same methods of the service utility. * However, the signatures are different because it is difficult for SOAP to * support certain types. * * <p> * ServiceBuilder follows certain rules in translating the methods. For example, * if the method in the service utility returns a {@link java.util.List}, that * is translated to an array of {@link com.liferay.dynamic.data.lists.model.DDLRecordSetSoap}. * If the method in the service utility returns a * {@link com.liferay.dynamic.data.lists.model.DDLRecordSet}, that is translated to a * {@link com.liferay.dynamic.data.lists.model.DDLRecordSetSoap}. Methods that SOAP cannot * safely wire are skipped. * </p> * * <p> * The benefits of using the SOAP utility is that it is cross platform * compatible. SOAP allows different languages like Java, .NET, C++, PHP, and * even Perl, to call the generated services. One drawback of SOAP is that it is * slow because it needs to serialize all calls into a text format (XML). * </p> * * <p> * You can see a list of services at http://localhost:8080/api/axis. Set the * property <b>axis.servlet.hosts.allowed</b> in portal.properties to configure * security. * </p> * * <p> * The SOAP utility is only generated for remote services. * </p> * * @author Brian Wing Shun Chan * @see DDLRecordSetServiceHttp * @see com.liferay.dynamic.data.lists.model.DDLRecordSetSoap * @see DDLRecordSetServiceUtil * @generated */ @ProviderType public class DDLRecordSetServiceSoap { /** * Adds a record set referencing the DDM structure. * * @param groupId the primary key of the record set's group * @param ddmStructureId the primary key of the record set's DDM structure * @param recordSetKey the mnemonic primary key of the record set. If <code>null</code>, the record set key will be autogenerated. * @param nameMap the record set's locales and localized names * @param descriptionMap the record set's locales and localized descriptions * @param minDisplayRows the record set's minimum number of rows to be displayed in spreadsheet view * @param scope the record set's scope, used to scope the record set's data. For more information search <code>DDLRecordSetConstants</code> in the <code>dynamic.data.lists.api</code> module for constants starting with the "SCOPE_" prefix. * @param serviceContext serviceContext the service context to be applied. This can set the UUID, guest permissions, and group permissions for the record set. * @return the record set * @throws PortalException if a portal exception occurred */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap addRecordSet( long groupId, long ddmStructureId, java.lang.String recordSetKey, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, int minDisplayRows, int scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException { try { Map<Locale, String> nameMap = LocalizationUtil.getLocalizationMap(nameMapLanguageIds, nameMapValues); Map<Locale, String> descriptionMap = LocalizationUtil.getLocalizationMap(descriptionMapLanguageIds, descriptionMapValues); com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.addRecordSet(groupId, ddmStructureId, recordSetKey, nameMap, descriptionMap, minDisplayRows, scope, serviceContext); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Deletes a record set and its resources. * * @param recordSetId the primary key of the record set * @throws PortalException if a portal exception occurred */ public static void deleteRecordSet(long recordSetId) throws RemoteException { try { DDLRecordSetServiceUtil.deleteRecordSet(recordSetId); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns a record set with the ID. * * @param recordSetId the primary key of the record set * @return the record set with the ID or <code>null</code> if the matching record set is not found * @throws PortalException if a portal exception occurred */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap fetchRecordSet( long recordSetId) throws RemoteException { try { com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.fetchRecordSet(recordSetId); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns a record set with the ID. * * @param recordSetId the primary key of the record set * @return the record set with the ID * @throws PortalException if a matching record set could not be found or if the user did not have the required permission to access the record set */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap getRecordSet( long recordSetId) throws RemoteException { try { com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.getRecordSet(recordSetId); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns all the record sets matching the groups, filtered by the user's * <code>VIEW</code> permission. * * @param groupIds the primary keys of the record set's groups * @return the matching record sets */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap[] getRecordSets( long[] groupIds) throws RemoteException { try { java.util.List<com.liferay.dynamic.data.lists.model.DDLRecordSet> returnValue = DDLRecordSetServiceUtil.getRecordSets(groupIds); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModels(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns a range of all record sets matching the parameters, filtered by * the user's <code>VIEW</code> permission. The keywords parameter is used * for matching String values to the record set's name or description. * * <p> * 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 <code>QueryUtil.ALL_POS</code> will return the * full result set. * </p> * * @param companyId the primary key of the record set's company * @param groupId the primary key of the record set's group * @param keywords the keywords (space separated), which my occur in the record set name or description (optionally <code>null</code>). If the keywords value is not <code>null</code>, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator. * @param scope the record set's scope. Constant used to scope the record set's data. For more information search the <code>dynamic.data.lists.api</code> module's <code>DDLRecordSetConstants</code> class for constants prefixed with "SCOPE_". * @param start the lower bound of the range of record sets to return * @param end the upper bound of the range of record sets to return (not inclusive) * @param orderByComparator the comparator to order the record sets * @return the range of matching record sets ordered by the comparator */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap[] search( long companyId, long groupId, java.lang.String keywords, int scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.dynamic.data.lists.model.DDLRecordSet> orderByComparator) throws RemoteException { try { java.util.List<com.liferay.dynamic.data.lists.model.DDLRecordSet> returnValue = DDLRecordSetServiceUtil.search(companyId, groupId, keywords, scope, start, end, orderByComparator); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModels(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns an ordered range of record sets, filtered by the user's * <code>VIEW</code> permission. Company ID and group ID must be matched. If * the and operator is set to <code>true</code>, only record sets with a * matching name, description, and scope are returned. If the and operator * is set to <code>false</code>, only one parameter of name, description, * and scope is needed to return matching record sets. * * <p> * 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 <code>QueryUtil.ALL_POS</code> will return the * full result set. * </p> * * @param companyId the primary key of the record set's company * @param groupId the primary key of the record set's group * @param name the name keywords (space separated, optionally <code>null</code>) * @param description the description keywords (space separated, optionally <code>null</code>) * @param scope the record set's scope. Constant used to scope the record set's data. For more information search the <code>dynamic.data.lists.api</code> module's <code>DDLRecordSetConstants</code> class for constants prefixed with "SCOPE_". * @param andOperator whether every field must match its value or keywords, or just one field must match. Company and group must match their values. * @param start the lower bound of the range of record sets to return * @param end the upper bound of the range of record sets to return (not inclusive) * @param orderByComparator the comparator to order the record sets * @return the range of matching record sets ordered by the comparator */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap[] search( long companyId, long groupId, java.lang.String name, java.lang.String description, int scope, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.dynamic.data.lists.model.DDLRecordSet> orderByComparator) throws RemoteException { try { java.util.List<com.liferay.dynamic.data.lists.model.DDLRecordSet> returnValue = DDLRecordSetServiceUtil.search(companyId, groupId, name, description, scope, andOperator, start, end, orderByComparator); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModels(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns the number of record sets matching the parameters, filtered by * the user's <code>VIEW</code> permission. The keywords parameter is used * for matching record set names or descriptions. * * @param companyId the primary key of the record set's company * @param groupId the primary key of the record set's group. * @param keywords the keywords (space separated) to look for and match in the record set name or description (optionally <code>null</code>). If the keywords value is not <code>null</code>, the OR operator is used in connecting query criteria; otherwise it uses the AND operator. * @param scope the record set's scope. A constant used to scope the record set's data. For more information search the <code>dynamic.data.lists.api</code> module's <code>DDLRecordSetConstants</code> class for constants prefixed with "SCOPE_". * @return the number of matching record sets */ public static int searchCount(long companyId, long groupId, java.lang.String keywords, int scope) throws RemoteException { try { int returnValue = DDLRecordSetServiceUtil.searchCount(companyId, groupId, keywords, scope); return returnValue; } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Returns the number of all record sets matching the parameters, filtered * by the user's <code>VIEW</code> permission. If the and operator is set to * <code>true</code>, only record sets with a matching name, description, * and scope are counted. If the and operator is set to <code>false</code>, * only one parameter of name, description, and scope is needed to count * matching record sets. * * @param companyId the primary key of the record set's company * @param groupId the primary key of the record set's group * @param name the name keywords (space separated). This can be <code>null</code>. * @param description the description keywords (space separated). Can be <code>null</code>. * @param scope the record set's scope. A constant used to scope the record set's data. For more information search the <code>dynamic.data.lists.api</code> module's <code>DDLRecordSetConstants</code> class for constants prefixed with "SCOPE_". * @param andOperator whether every field must match its value or keywords, or just one field must match. Company and group must match their values. * @return the number of matching record sets */ public static int searchCount(long companyId, long groupId, java.lang.String name, java.lang.String description, int scope, boolean andOperator) throws RemoteException { try { int returnValue = DDLRecordSetServiceUtil.searchCount(companyId, groupId, name, description, scope, andOperator); return returnValue; } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Updates the number of minimum rows to display for the record set. Useful * when the record set is being displayed in spreadsheet. * * @param recordSetId the primary key of the record set * @param minDisplayRows the record set's minimum number of rows to be displayed in spreadsheet view * @param serviceContext the service context to be applied. This can set the record set modified date. * @return the record set * @throws PortalException if a portal exception occurred */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap updateMinDisplayRows( long recordSetId, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException { try { com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.updateMinDisplayRows(recordSetId, minDisplayRows, serviceContext); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Updates the the record set's settings. * * @param recordSetId the primary key of the record set * @param settingsDDMFormValues the record set's settings. For more information see <code>DDMFormValues</code> in the <code>dynamic.data.mapping.api</code> module. * @return the record set * @throws PortalException if a portal exception occurred */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap updateRecordSet( long recordSetId, com.liferay.dynamic.data.mapping.storage.DDMFormValues settingsDDMFormValues) throws RemoteException { try { com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.updateRecordSet(recordSetId, settingsDDMFormValues); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Updates the DDM structure, name, description, and minimum number of * display rows for the record set matching the record set ID. * * @param recordSetId the primary key of the record set * @param ddmStructureId the primary key of the record set's DDM structure * @param nameMap the record set's locales and localized names * @param descriptionMap the record set's locales and localized descriptions * @param minDisplayRows the record set's minimum number of rows to be displayed in spreadsheet view. * @param serviceContext the service context to be applied. Can set the record set modified date. * @return the record set * @throws PortalException if a portal exception occurred */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap updateRecordSet( long recordSetId, long ddmStructureId, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException { try { Map<Locale, String> nameMap = LocalizationUtil.getLocalizationMap(nameMapLanguageIds, nameMapValues); Map<Locale, String> descriptionMap = LocalizationUtil.getLocalizationMap(descriptionMapLanguageIds, descriptionMapValues); com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.updateRecordSet(recordSetId, ddmStructureId, nameMap, descriptionMap, minDisplayRows, serviceContext); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } /** * Updates the DDM structure, name, description, and minimum number of * display rows for the record set matching the group ID and record set key. * * @param groupId the primary key of the record set's group * @param ddmStructureId the primary key of the record set's DDM structure * @param recordSetKey the record set's mnemonic primary key * @param nameMap the record set's locales and localized names * @param descriptionMap the record set's locales and localized descriptions * @param minDisplayRows the record set's minimum number of rows to be displayed in spreadsheet view * @param serviceContext the service context to be applied. This can set the record set modified date. * @return the record set * @throws PortalException if a portal exception occurred */ public static com.liferay.dynamic.data.lists.model.DDLRecordSetSoap updateRecordSet( long groupId, long ddmStructureId, java.lang.String recordSetKey, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException { try { Map<Locale, String> nameMap = LocalizationUtil.getLocalizationMap(nameMapLanguageIds, nameMapValues); Map<Locale, String> descriptionMap = LocalizationUtil.getLocalizationMap(descriptionMapLanguageIds, descriptionMapValues); com.liferay.dynamic.data.lists.model.DDLRecordSet returnValue = DDLRecordSetServiceUtil.updateRecordSet(groupId, ddmStructureId, recordSetKey, nameMap, descriptionMap, minDisplayRows, serviceContext); return com.liferay.dynamic.data.lists.model.DDLRecordSetSoap.toSoapModel(returnValue); } catch (Exception e) { _log.error(e, e); throw new RemoteException(e.getMessage()); } } private static Log _log = LogFactoryUtil.getLog(DDLRecordSetServiceSoap.class); }