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 com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.service.ServiceContext; 019 020 import com.liferay.portlet.expando.model.ExpandoBridge; 021 022 import java.io.Serializable; 023 024 /** 025 * 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. 026 * 027 * <p> 028 * 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}. 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see Shard 033 * @see com.liferay.portal.model.impl.ShardImpl 034 * @see com.liferay.portal.model.impl.ShardModelImpl 035 * @generated 036 */ 037 public interface ShardModel extends AttachedModel, BaseModel<Shard> { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify or reference this interface directly. All methods that expect a shard model instance should use the {@link Shard} interface instead. 042 */ 043 044 /** 045 * Returns the primary key of this shard. 046 * 047 * @return the primary key of this shard 048 */ 049 public long getPrimaryKey(); 050 051 /** 052 * Sets the primary key of this shard. 053 * 054 * @param primaryKey the primary key of this shard 055 */ 056 public void setPrimaryKey(long primaryKey); 057 058 /** 059 * Returns the shard ID of this shard. 060 * 061 * @return the shard ID of this shard 062 */ 063 public long getShardId(); 064 065 /** 066 * Sets the shard ID of this shard. 067 * 068 * @param shardId the shard ID of this shard 069 */ 070 public void setShardId(long shardId); 071 072 /** 073 * Returns the fully qualified class name of this shard. 074 * 075 * @return the fully qualified class name of this shard 076 */ 077 public String getClassName(); 078 079 public void setClassName(String className); 080 081 /** 082 * Returns the class name ID of this shard. 083 * 084 * @return the class name ID of this shard 085 */ 086 public long getClassNameId(); 087 088 /** 089 * Sets the class name ID of this shard. 090 * 091 * @param classNameId the class name ID of this shard 092 */ 093 public void setClassNameId(long classNameId); 094 095 /** 096 * Returns the class p k of this shard. 097 * 098 * @return the class p k of this shard 099 */ 100 public long getClassPK(); 101 102 /** 103 * Sets the class p k of this shard. 104 * 105 * @param classPK the class p k of this shard 106 */ 107 public void setClassPK(long classPK); 108 109 /** 110 * Returns the name of this shard. 111 * 112 * @return the name of this shard 113 */ 114 @AutoEscape 115 public String getName(); 116 117 /** 118 * Sets the name of this shard. 119 * 120 * @param name the name of this shard 121 */ 122 public void setName(String name); 123 124 public boolean isNew(); 125 126 public void setNew(boolean n); 127 128 public boolean isCachedModel(); 129 130 public void setCachedModel(boolean cachedModel); 131 132 public boolean isEscapedModel(); 133 134 public Serializable getPrimaryKeyObj(); 135 136 public void setPrimaryKeyObj(Serializable primaryKeyObj); 137 138 public ExpandoBridge getExpandoBridge(); 139 140 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 141 142 public Object clone(); 143 144 public int compareTo(Shard shard); 145 146 public int hashCode(); 147 148 public CacheModel<Shard> toCacheModel(); 149 150 public Shard toEscapedModel(); 151 152 public Shard toUnescapedModel(); 153 154 public String toString(); 155 156 public String toXmlString(); 157 }