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.model;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    /**
027     * The base model interface for the Shard service. Represents a row in the "Shard" database table, with each column mapped to a property of this class.
028     *
029     * <p>
030     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.ShardModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.ShardImpl}.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see Shard
035     * @see com.liferay.portal.model.impl.ShardImpl
036     * @see com.liferay.portal.model.impl.ShardModelImpl
037     * @generated
038     */
039    @ProviderType
040    public interface ShardModel extends AttachedModel, BaseModel<Shard> {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. All methods that expect a shard model instance should use the {@link Shard} interface instead.
045             */
046    
047            /**
048             * Returns the primary key of this shard.
049             *
050             * @return the primary key of this shard
051             */
052            public long getPrimaryKey();
053    
054            /**
055             * Sets the primary key of this shard.
056             *
057             * @param primaryKey the primary key of this shard
058             */
059            public void setPrimaryKey(long primaryKey);
060    
061            /**
062             * Returns the shard ID of this shard.
063             *
064             * @return the shard ID of this shard
065             */
066            public long getShardId();
067    
068            /**
069             * Sets the shard ID of this shard.
070             *
071             * @param shardId the shard ID of this shard
072             */
073            public void setShardId(long shardId);
074    
075            /**
076             * Returns the fully qualified class name of this shard.
077             *
078             * @return the fully qualified class name of this shard
079             */
080            @Override
081            public String getClassName();
082    
083            public void setClassName(String className);
084    
085            /**
086             * Returns the class name ID of this shard.
087             *
088             * @return the class name ID of this shard
089             */
090            @Override
091            public long getClassNameId();
092    
093            /**
094             * Sets the class name ID of this shard.
095             *
096             * @param classNameId the class name ID of this shard
097             */
098            @Override
099            public void setClassNameId(long classNameId);
100    
101            /**
102             * Returns the class p k of this shard.
103             *
104             * @return the class p k of this shard
105             */
106            @Override
107            public long getClassPK();
108    
109            /**
110             * Sets the class p k of this shard.
111             *
112             * @param classPK the class p k of this shard
113             */
114            @Override
115            public void setClassPK(long classPK);
116    
117            /**
118             * Returns the name of this shard.
119             *
120             * @return the name of this shard
121             */
122            @AutoEscape
123            public String getName();
124    
125            /**
126             * Sets the name of this shard.
127             *
128             * @param name the name of this shard
129             */
130            public void setName(String name);
131    
132            @Override
133            public boolean isNew();
134    
135            @Override
136            public void setNew(boolean n);
137    
138            @Override
139            public boolean isCachedModel();
140    
141            @Override
142            public void setCachedModel(boolean cachedModel);
143    
144            @Override
145            public boolean isEscapedModel();
146    
147            @Override
148            public Serializable getPrimaryKeyObj();
149    
150            @Override
151            public void setPrimaryKeyObj(Serializable primaryKeyObj);
152    
153            @Override
154            public ExpandoBridge getExpandoBridge();
155    
156            @Override
157            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
158    
159            @Override
160            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
161    
162            @Override
163            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
164    
165            @Override
166            public Object clone();
167    
168            @Override
169            public int compareTo(Shard shard);
170    
171            @Override
172            public int hashCode();
173    
174            @Override
175            public CacheModel<Shard> toCacheModel();
176    
177            @Override
178            public Shard toEscapedModel();
179    
180            @Override
181            public Shard toUnescapedModel();
182    
183            @Override
184            public String toString();
185    
186            @Override
187            public String toXmlString();
188    }