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