001    /**
002     * Copyright (c) 2000-2011 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.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 ClassName service. Represents a row in the "ClassName_" 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.ClassNameModelImpl} 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.ClassNameImpl}.
029     * </p>
030     *
031     * <p>
032     * Never modify or reference this interface directly. All methods that expect a class name model instance should use the {@link ClassName} interface instead.
033     * </p>
034     *
035     * @author Brian Wing Shun Chan
036     * @see ClassName
037     * @see com.liferay.portal.model.impl.ClassNameImpl
038     * @see com.liferay.portal.model.impl.ClassNameModelImpl
039     * @generated
040     */
041    public interface ClassNameModel extends BaseModel<ClassName> {
042            /**
043             * Gets the primary key of this class name.
044             *
045             * @return the primary key of this class name
046             */
047            public long getPrimaryKey();
048    
049            /**
050             * Sets the primary key of this class name
051             *
052             * @param pk the primary key of this class name
053             */
054            public void setPrimaryKey(long pk);
055    
056            /**
057             * Gets the class name of the model instance this class name is polymorphically associated with.
058             *
059             * @return the class name of the model instance this class name is polymorphically associated with
060             */
061            public String getClassName();
062    
063            /**
064             * Gets the class name id of this class name.
065             *
066             * @return the class name id of this class name
067             */
068            public long getClassNameId();
069    
070            /**
071             * Sets the class name id of this class name.
072             *
073             * @param classNameId the class name id of this class name
074             */
075            public void setClassNameId(long classNameId);
076    
077            /**
078             * Gets the value of this class name.
079             *
080             * @return the value of this class name
081             */
082            @AutoEscape
083            public String getValue();
084    
085            /**
086             * Sets the value of this class name.
087             *
088             * @param value the value of this class name
089             */
090            public void setValue(String value);
091    
092            /**
093             * Gets a copy of this class name as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}.
094             *
095             * @return the escaped model instance
096             * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler
097             */
098            public ClassName toEscapedModel();
099    
100            public boolean isNew();
101    
102            public void setNew(boolean n);
103    
104            public boolean isCachedModel();
105    
106            public void setCachedModel(boolean cachedModel);
107    
108            public boolean isEscapedModel();
109    
110            public void setEscapedModel(boolean escapedModel);
111    
112            public Serializable getPrimaryKeyObj();
113    
114            public ExpandoBridge getExpandoBridge();
115    
116            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
117    
118            public Object clone();
119    
120            public int compareTo(ClassName className);
121    
122            public int hashCode();
123    
124            public String toString();
125    
126            public String toXmlString();
127    }