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 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the local service utility for ListType. This utility wraps 024 * {@link com.liferay.portal.service.impl.ListTypeLocalServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on the local server. Methods of this service will not have security checks 027 * based on the propagated JAAS credentials because this service can only be 028 * accessed from within the same VM. 029 * 030 * @author Brian Wing Shun Chan 031 * @see ListTypeLocalService 032 * @see com.liferay.portal.service.base.ListTypeLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.ListTypeLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class ListTypeLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.ListTypeLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the list type to the database. Also notifies the appropriate model listeners. 046 * 047 * @param listType the list type 048 * @return the list type that was added 049 */ 050 public static com.liferay.portal.model.ListType addListType( 051 com.liferay.portal.model.ListType listType) { 052 return getService().addListType(listType); 053 } 054 055 public static com.liferay.portal.model.ListType addListType( 056 java.lang.String name, java.lang.String type) { 057 return getService().addListType(name, type); 058 } 059 060 /** 061 * Creates a new list type with the primary key. Does not add the list type to the database. 062 * 063 * @param listTypeId the primary key for the new list type 064 * @return the new list type 065 */ 066 public static com.liferay.portal.model.ListType createListType( 067 long listTypeId) { 068 return getService().createListType(listTypeId); 069 } 070 071 /** 072 * Deletes the list type from the database. Also notifies the appropriate model listeners. 073 * 074 * @param listType the list type 075 * @return the list type that was removed 076 */ 077 public static com.liferay.portal.model.ListType deleteListType( 078 com.liferay.portal.model.ListType listType) { 079 return getService().deleteListType(listType); 080 } 081 082 /** 083 * Deletes the list type with the primary key from the database. Also notifies the appropriate model listeners. 084 * 085 * @param listTypeId the primary key of the list type 086 * @return the list type that was removed 087 * @throws PortalException if a list type with the primary key could not be found 088 */ 089 public static com.liferay.portal.model.ListType deleteListType( 090 long listTypeId) 091 throws com.liferay.portal.kernel.exception.PortalException { 092 return getService().deleteListType(listTypeId); 093 } 094 095 /** 096 * @throws PortalException 097 */ 098 public static com.liferay.portal.model.PersistedModel deletePersistedModel( 099 com.liferay.portal.model.PersistedModel persistedModel) 100 throws com.liferay.portal.kernel.exception.PortalException { 101 return getService().deletePersistedModel(persistedModel); 102 } 103 104 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 105 return getService().dynamicQuery(); 106 } 107 108 /** 109 * Performs a dynamic query on the database and returns the matching rows. 110 * 111 * @param dynamicQuery the dynamic query 112 * @return the matching rows 113 */ 114 public static <T> java.util.List<T> dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 116 return getService().dynamicQuery(dynamicQuery); 117 } 118 119 /** 120 * Performs a dynamic query on the database and returns a range of the matching rows. 121 * 122 * <p> 123 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ListTypeModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 124 * </p> 125 * 126 * @param dynamicQuery the dynamic query 127 * @param start the lower bound of the range of model instances 128 * @param end the upper bound of the range of model instances (not inclusive) 129 * @return the range of matching rows 130 */ 131 public static <T> java.util.List<T> dynamicQuery( 132 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 133 int end) { 134 return getService().dynamicQuery(dynamicQuery, start, end); 135 } 136 137 /** 138 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 139 * 140 * <p> 141 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ListTypeModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 142 * </p> 143 * 144 * @param dynamicQuery the dynamic query 145 * @param start the lower bound of the range of model instances 146 * @param end the upper bound of the range of model instances (not inclusive) 147 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 148 * @return the ordered range of matching rows 149 */ 150 public static <T> java.util.List<T> dynamicQuery( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 152 int end, 153 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) { 154 return getService() 155 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 156 } 157 158 /** 159 * Returns the number of rows matching the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @return the number of rows matching the dynamic query 163 */ 164 public static long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 166 return getService().dynamicQueryCount(dynamicQuery); 167 } 168 169 /** 170 * Returns the number of rows matching the dynamic query. 171 * 172 * @param dynamicQuery the dynamic query 173 * @param projection the projection to apply to the query 174 * @return the number of rows matching the dynamic query 175 */ 176 public static long dynamicQueryCount( 177 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 178 com.liferay.portal.kernel.dao.orm.Projection projection) { 179 return getService().dynamicQueryCount(dynamicQuery, projection); 180 } 181 182 public static com.liferay.portal.model.ListType fetchListType( 183 long listTypeId) { 184 return getService().fetchListType(listTypeId); 185 } 186 187 public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { 188 return getService().getActionableDynamicQuery(); 189 } 190 191 public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { 192 return getService().getIndexableActionableDynamicQuery(); 193 } 194 195 /** 196 * Returns the list type with the primary key. 197 * 198 * @param listTypeId the primary key of the list type 199 * @return the list type 200 * @throws PortalException if a list type with the primary key could not be found 201 */ 202 public static com.liferay.portal.model.ListType getListType(long listTypeId) 203 throws com.liferay.portal.kernel.exception.PortalException { 204 return getService().getListType(listTypeId); 205 } 206 207 /** 208 * Returns a range of all the list types. 209 * 210 * <p> 211 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ListTypeModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 212 * </p> 213 * 214 * @param start the lower bound of the range of list types 215 * @param end the upper bound of the range of list types (not inclusive) 216 * @return the range of list types 217 */ 218 public static java.util.List<com.liferay.portal.model.ListType> getListTypes( 219 int start, int end) { 220 return getService().getListTypes(start, end); 221 } 222 223 public static java.util.List<com.liferay.portal.model.ListType> getListTypes( 224 java.lang.String type) { 225 return getService().getListTypes(type); 226 } 227 228 /** 229 * Returns the number of list types. 230 * 231 * @return the number of list types 232 */ 233 public static int getListTypesCount() { 234 return getService().getListTypesCount(); 235 } 236 237 /** 238 * Returns the OSGi service identifier. 239 * 240 * @return the OSGi service identifier 241 */ 242 public static java.lang.String getOSGiServiceIdentifier() { 243 return getService().getOSGiServiceIdentifier(); 244 } 245 246 public static com.liferay.portal.model.PersistedModel getPersistedModel( 247 java.io.Serializable primaryKeyObj) 248 throws com.liferay.portal.kernel.exception.PortalException { 249 return getService().getPersistedModel(primaryKeyObj); 250 } 251 252 /** 253 * Updates the list type in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 254 * 255 * @param listType the list type 256 * @return the list type that was updated 257 */ 258 public static com.liferay.portal.model.ListType updateListType( 259 com.liferay.portal.model.ListType listType) { 260 return getService().updateListType(listType); 261 } 262 263 public static void validate(long listTypeId, long classNameId, 264 java.lang.String type) 265 throws com.liferay.portal.kernel.exception.PortalException { 266 getService().validate(listTypeId, classNameId, type); 267 } 268 269 public static void validate(long listTypeId, java.lang.String type) 270 throws com.liferay.portal.kernel.exception.PortalException { 271 getService().validate(listTypeId, type); 272 } 273 274 public static ListTypeLocalService getService() { 275 if (_service == null) { 276 _service = (ListTypeLocalService)PortalBeanLocatorUtil.locate(ListTypeLocalService.class.getName()); 277 278 ReferenceRegistry.registerReference(ListTypeLocalServiceUtil.class, 279 "_service"); 280 } 281 282 return _service; 283 } 284 285 private static ListTypeLocalService _service; 286 }