001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portal.model; 016 017 import com.liferay.portal.kernel.annotation.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 * <p> 032 * Never modify or reference this interface directly. All methods that expect a shard model instance should use the {@link Shard} interface instead. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see Shard 037 * @see com.liferay.portal.model.impl.ShardImpl 038 * @see com.liferay.portal.model.impl.ShardModelImpl 039 * @generated 040 */ 041 public interface ShardModel extends BaseModel<Shard> { 042 /** 043 * Gets the primary key of this shard. 044 * 045 * @return the primary key of this shard 046 */ 047 public long getPrimaryKey(); 048 049 /** 050 * Sets the primary key of this shard 051 * 052 * @param pk the primary key of this shard 053 */ 054 public void setPrimaryKey(long pk); 055 056 /** 057 * Gets the shard id of this shard. 058 * 059 * @return the shard id of this shard 060 */ 061 public long getShardId(); 062 063 /** 064 * Sets the shard id of this shard. 065 * 066 * @param shardId the shard id of this shard 067 */ 068 public void setShardId(long shardId); 069 070 /** 071 * Gets the class name of the model instance this shard is polymorphically associated with. 072 * 073 * @return the class name of the model instance this shard is polymorphically associated with 074 */ 075 public String getClassName(); 076 077 /** 078 * Gets the class name id of this shard. 079 * 080 * @return the class name id of this shard 081 */ 082 public long getClassNameId(); 083 084 /** 085 * Sets the class name id of this shard. 086 * 087 * @param classNameId the class name id of this shard 088 */ 089 public void setClassNameId(long classNameId); 090 091 /** 092 * Gets the class p k of this shard. 093 * 094 * @return the class p k of this shard 095 */ 096 public long getClassPK(); 097 098 /** 099 * Sets the class p k of this shard. 100 * 101 * @param classPK the class p k of this shard 102 */ 103 public void setClassPK(long classPK); 104 105 /** 106 * Gets the name of this shard. 107 * 108 * @return the name of this shard 109 */ 110 @AutoEscape 111 public String getName(); 112 113 /** 114 * Sets the name of this shard. 115 * 116 * @param name the name of this shard 117 */ 118 public void setName(String name); 119 120 public boolean isNew(); 121 122 public void setNew(boolean n); 123 124 public boolean isCachedModel(); 125 126 public void setCachedModel(boolean cachedModel); 127 128 public boolean isEscapedModel(); 129 130 public void setEscapedModel(boolean escapedModel); 131 132 public Serializable getPrimaryKeyObj(); 133 134 public ExpandoBridge getExpandoBridge(); 135 136 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 137 138 public Object clone(); 139 140 public int compareTo(Shard shard); 141 142 public int hashCode(); 143 144 public Shard toEscapedModel(); 145 146 public String toString(); 147 148 public String toXmlString(); 149 }