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