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