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 ClusterGroup service. Represents a row in the "ClusterGroup" 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.ClusterGroupModelImpl} 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.ClusterGroupImpl}. 031 * </p> 032 * 033 * @author Brian Wing Shun Chan 034 * @see ClusterGroup 035 * @see com.liferay.portal.model.impl.ClusterGroupImpl 036 * @see com.liferay.portal.model.impl.ClusterGroupModelImpl 037 * @generated 038 */ 039 @ProviderType 040 public interface ClusterGroupModel extends BaseModel<ClusterGroup> { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. All methods that expect a cluster group model instance should use the {@link ClusterGroup} interface instead. 045 */ 046 047 /** 048 * Returns the primary key of this cluster group. 049 * 050 * @return the primary key of this cluster group 051 */ 052 public long getPrimaryKey(); 053 054 /** 055 * Sets the primary key of this cluster group. 056 * 057 * @param primaryKey the primary key of this cluster group 058 */ 059 public void setPrimaryKey(long primaryKey); 060 061 /** 062 * Returns the cluster group ID of this cluster group. 063 * 064 * @return the cluster group ID of this cluster group 065 */ 066 public long getClusterGroupId(); 067 068 /** 069 * Sets the cluster group ID of this cluster group. 070 * 071 * @param clusterGroupId the cluster group ID of this cluster group 072 */ 073 public void setClusterGroupId(long clusterGroupId); 074 075 /** 076 * Returns the name of this cluster group. 077 * 078 * @return the name of this cluster group 079 */ 080 @AutoEscape 081 public String getName(); 082 083 /** 084 * Sets the name of this cluster group. 085 * 086 * @param name the name of this cluster group 087 */ 088 public void setName(String name); 089 090 /** 091 * Returns the cluster node IDs of this cluster group. 092 * 093 * @return the cluster node IDs of this cluster group 094 */ 095 @AutoEscape 096 public String getClusterNodeIds(); 097 098 /** 099 * Sets the cluster node IDs of this cluster group. 100 * 101 * @param clusterNodeIds the cluster node IDs of this cluster group 102 */ 103 public void setClusterNodeIds(String clusterNodeIds); 104 105 /** 106 * Returns the whole cluster of this cluster group. 107 * 108 * @return the whole cluster of this cluster group 109 */ 110 public boolean getWholeCluster(); 111 112 /** 113 * Returns <code>true</code> if this cluster group is whole cluster. 114 * 115 * @return <code>true</code> if this cluster group is whole cluster; <code>false</code> otherwise 116 */ 117 public boolean isWholeCluster(); 118 119 /** 120 * Sets whether this cluster group is whole cluster. 121 * 122 * @param wholeCluster the whole cluster of this cluster group 123 */ 124 public void setWholeCluster(boolean wholeCluster); 125 126 @Override 127 public boolean isNew(); 128 129 @Override 130 public void setNew(boolean n); 131 132 @Override 133 public boolean isCachedModel(); 134 135 @Override 136 public void setCachedModel(boolean cachedModel); 137 138 @Override 139 public boolean isEscapedModel(); 140 141 @Override 142 public Serializable getPrimaryKeyObj(); 143 144 @Override 145 public void setPrimaryKeyObj(Serializable primaryKeyObj); 146 147 @Override 148 public ExpandoBridge getExpandoBridge(); 149 150 @Override 151 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 152 153 @Override 154 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 155 156 @Override 157 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 158 159 @Override 160 public Object clone(); 161 162 @Override 163 public int compareTo(ClusterGroup clusterGroup); 164 165 @Override 166 public int hashCode(); 167 168 @Override 169 public CacheModel<ClusterGroup> toCacheModel(); 170 171 @Override 172 public ClusterGroup toEscapedModel(); 173 174 @Override 175 public ClusterGroup toUnescapedModel(); 176 177 @Override 178 public String toString(); 179 180 @Override 181 public String toXmlString(); 182 }