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.kernel.exception.SystemException;
019    import com.liferay.portal.service.ServiceContext;
020    
021    import com.liferay.portlet.expando.model.ExpandoBridge;
022    
023    import java.io.Serializable;
024    
025    import java.util.Date;
026    
027    /**
028     * The base model interface for the Organization service. Represents a row in the "Organization_" database table, with each column mapped to a property of this class.
029     *
030     * <p>
031     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.OrganizationModelImpl} 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.OrganizationImpl}.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see Organization
036     * @see com.liferay.portal.model.impl.OrganizationImpl
037     * @see com.liferay.portal.model.impl.OrganizationModelImpl
038     * @generated
039     */
040    public interface OrganizationModel extends BaseModel<Organization>,
041            StagedAuditedModel {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. All methods that expect a organization model instance should use the {@link Organization} interface instead.
046             */
047    
048            /**
049             * Returns the primary key of this organization.
050             *
051             * @return the primary key of this organization
052             */
053            public long getPrimaryKey();
054    
055            /**
056             * Sets the primary key of this organization.
057             *
058             * @param primaryKey the primary key of this organization
059             */
060            public void setPrimaryKey(long primaryKey);
061    
062            /**
063             * Returns the uuid of this organization.
064             *
065             * @return the uuid of this organization
066             */
067            @AutoEscape
068            @Override
069            public String getUuid();
070    
071            /**
072             * Sets the uuid of this organization.
073             *
074             * @param uuid the uuid of this organization
075             */
076            @Override
077            public void setUuid(String uuid);
078    
079            /**
080             * Returns the organization ID of this organization.
081             *
082             * @return the organization ID of this organization
083             */
084            public long getOrganizationId();
085    
086            /**
087             * Sets the organization ID of this organization.
088             *
089             * @param organizationId the organization ID of this organization
090             */
091            public void setOrganizationId(long organizationId);
092    
093            /**
094             * Returns the company ID of this organization.
095             *
096             * @return the company ID of this organization
097             */
098            @Override
099            public long getCompanyId();
100    
101            /**
102             * Sets the company ID of this organization.
103             *
104             * @param companyId the company ID of this organization
105             */
106            @Override
107            public void setCompanyId(long companyId);
108    
109            /**
110             * Returns the user ID of this organization.
111             *
112             * @return the user ID of this organization
113             */
114            @Override
115            public long getUserId();
116    
117            /**
118             * Sets the user ID of this organization.
119             *
120             * @param userId the user ID of this organization
121             */
122            @Override
123            public void setUserId(long userId);
124    
125            /**
126             * Returns the user uuid of this organization.
127             *
128             * @return the user uuid of this organization
129             * @throws SystemException if a system exception occurred
130             */
131            @Override
132            public String getUserUuid() throws SystemException;
133    
134            /**
135             * Sets the user uuid of this organization.
136             *
137             * @param userUuid the user uuid of this organization
138             */
139            @Override
140            public void setUserUuid(String userUuid);
141    
142            /**
143             * Returns the user name of this organization.
144             *
145             * @return the user name of this organization
146             */
147            @AutoEscape
148            @Override
149            public String getUserName();
150    
151            /**
152             * Sets the user name of this organization.
153             *
154             * @param userName the user name of this organization
155             */
156            @Override
157            public void setUserName(String userName);
158    
159            /**
160             * Returns the create date of this organization.
161             *
162             * @return the create date of this organization
163             */
164            @Override
165            public Date getCreateDate();
166    
167            /**
168             * Sets the create date of this organization.
169             *
170             * @param createDate the create date of this organization
171             */
172            @Override
173            public void setCreateDate(Date createDate);
174    
175            /**
176             * Returns the modified date of this organization.
177             *
178             * @return the modified date of this organization
179             */
180            @Override
181            public Date getModifiedDate();
182    
183            /**
184             * Sets the modified date of this organization.
185             *
186             * @param modifiedDate the modified date of this organization
187             */
188            @Override
189            public void setModifiedDate(Date modifiedDate);
190    
191            /**
192             * Returns the parent organization ID of this organization.
193             *
194             * @return the parent organization ID of this organization
195             */
196            public long getParentOrganizationId();
197    
198            /**
199             * Sets the parent organization ID of this organization.
200             *
201             * @param parentOrganizationId the parent organization ID of this organization
202             */
203            public void setParentOrganizationId(long parentOrganizationId);
204    
205            /**
206             * Returns the tree path of this organization.
207             *
208             * @return the tree path of this organization
209             */
210            @AutoEscape
211            public String getTreePath();
212    
213            /**
214             * Sets the tree path of this organization.
215             *
216             * @param treePath the tree path of this organization
217             */
218            public void setTreePath(String treePath);
219    
220            /**
221             * Returns the name of this organization.
222             *
223             * @return the name of this organization
224             */
225            @AutoEscape
226            public String getName();
227    
228            /**
229             * Sets the name of this organization.
230             *
231             * @param name the name of this organization
232             */
233            public void setName(String name);
234    
235            /**
236             * Returns the type of this organization.
237             *
238             * @return the type of this organization
239             */
240            public String getType();
241    
242            /**
243             * Sets the type of this organization.
244             *
245             * @param type the type of this organization
246             */
247            public void setType(String type);
248    
249            /**
250             * Returns the recursable of this organization.
251             *
252             * @return the recursable of this organization
253             */
254            public boolean getRecursable();
255    
256            /**
257             * Returns <code>true</code> if this organization is recursable.
258             *
259             * @return <code>true</code> if this organization is recursable; <code>false</code> otherwise
260             */
261            public boolean isRecursable();
262    
263            /**
264             * Sets whether this organization is recursable.
265             *
266             * @param recursable the recursable of this organization
267             */
268            public void setRecursable(boolean recursable);
269    
270            /**
271             * Returns the region ID of this organization.
272             *
273             * @return the region ID of this organization
274             */
275            public long getRegionId();
276    
277            /**
278             * Sets the region ID of this organization.
279             *
280             * @param regionId the region ID of this organization
281             */
282            public void setRegionId(long regionId);
283    
284            /**
285             * Returns the country ID of this organization.
286             *
287             * @return the country ID of this organization
288             */
289            public long getCountryId();
290    
291            /**
292             * Sets the country ID of this organization.
293             *
294             * @param countryId the country ID of this organization
295             */
296            public void setCountryId(long countryId);
297    
298            /**
299             * Returns the status ID of this organization.
300             *
301             * @return the status ID of this organization
302             */
303            public int getStatusId();
304    
305            /**
306             * Sets the status ID of this organization.
307             *
308             * @param statusId the status ID of this organization
309             */
310            public void setStatusId(int statusId);
311    
312            /**
313             * Returns the comments of this organization.
314             *
315             * @return the comments of this organization
316             */
317            @AutoEscape
318            public String getComments();
319    
320            /**
321             * Sets the comments of this organization.
322             *
323             * @param comments the comments of this organization
324             */
325            public void setComments(String comments);
326    
327            @Override
328            public boolean isNew();
329    
330            @Override
331            public void setNew(boolean n);
332    
333            @Override
334            public boolean isCachedModel();
335    
336            @Override
337            public void setCachedModel(boolean cachedModel);
338    
339            @Override
340            public boolean isEscapedModel();
341    
342            @Override
343            public Serializable getPrimaryKeyObj();
344    
345            @Override
346            public void setPrimaryKeyObj(Serializable primaryKeyObj);
347    
348            @Override
349            public ExpandoBridge getExpandoBridge();
350    
351            @Override
352            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
353    
354            @Override
355            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
356    
357            @Override
358            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
359    
360            @Override
361            public Object clone();
362    
363            @Override
364            public int compareTo(Organization organization);
365    
366            @Override
367            public int hashCode();
368    
369            @Override
370            public CacheModel<Organization> toCacheModel();
371    
372            @Override
373            public Organization toEscapedModel();
374    
375            @Override
376            public Organization toUnescapedModel();
377    
378            @Override
379            public String toString();
380    
381            @Override
382            public String toXmlString();
383    }