001    /**
002     * Copyright (c) 2000-present 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.LocaleException;
020    import com.liferay.portal.kernel.bean.AutoEscape;
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.Locale;
028    import java.util.Map;
029    
030    /**
031     * The base model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class.
032     *
033     * <p>
034     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.GroupModelImpl} 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.GroupImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see Group
039     * @see com.liferay.portal.model.impl.GroupImpl
040     * @see com.liferay.portal.model.impl.GroupModelImpl
041     * @generated
042     */
043    @ProviderType
044    public interface GroupModel extends AttachedModel, BaseModel<Group>,
045            LocalizedModel, MVCCModel {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. All methods that expect a group model instance should use the {@link Group} interface instead.
050             */
051    
052            /**
053             * Returns the primary key of this group.
054             *
055             * @return the primary key of this group
056             */
057            public long getPrimaryKey();
058    
059            /**
060             * Sets the primary key of this group.
061             *
062             * @param primaryKey the primary key of this group
063             */
064            public void setPrimaryKey(long primaryKey);
065    
066            /**
067             * Returns the mvcc version of this group.
068             *
069             * @return the mvcc version of this group
070             */
071            @Override
072            public long getMvccVersion();
073    
074            /**
075             * Sets the mvcc version of this group.
076             *
077             * @param mvccVersion the mvcc version of this group
078             */
079            @Override
080            public void setMvccVersion(long mvccVersion);
081    
082            /**
083             * Returns the uuid of this group.
084             *
085             * @return the uuid of this group
086             */
087            @AutoEscape
088            public String getUuid();
089    
090            /**
091             * Sets the uuid of this group.
092             *
093             * @param uuid the uuid of this group
094             */
095            public void setUuid(String uuid);
096    
097            /**
098             * Returns the group ID of this group.
099             *
100             * @return the group ID of this group
101             */
102            public long getGroupId();
103    
104            /**
105             * Sets the group ID of this group.
106             *
107             * @param groupId the group ID of this group
108             */
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this group.
113             *
114             * @return the company ID of this group
115             */
116            public long getCompanyId();
117    
118            /**
119             * Sets the company ID of this group.
120             *
121             * @param companyId the company ID of this group
122             */
123            public void setCompanyId(long companyId);
124    
125            /**
126             * Returns the creator user ID of this group.
127             *
128             * @return the creator user ID of this group
129             */
130            public long getCreatorUserId();
131    
132            /**
133             * Sets the creator user ID of this group.
134             *
135             * @param creatorUserId the creator user ID of this group
136             */
137            public void setCreatorUserId(long creatorUserId);
138    
139            /**
140             * Returns the creator user uuid of this group.
141             *
142             * @return the creator user uuid of this group
143             */
144            public String getCreatorUserUuid();
145    
146            /**
147             * Sets the creator user uuid of this group.
148             *
149             * @param creatorUserUuid the creator user uuid of this group
150             */
151            public void setCreatorUserUuid(String creatorUserUuid);
152    
153            /**
154             * Returns the fully qualified class name of this group.
155             *
156             * @return the fully qualified class name of this group
157             */
158            @Override
159            public String getClassName();
160    
161            public void setClassName(String className);
162    
163            /**
164             * Returns the class name ID of this group.
165             *
166             * @return the class name ID of this group
167             */
168            @Override
169            public long getClassNameId();
170    
171            /**
172             * Sets the class name ID of this group.
173             *
174             * @param classNameId the class name ID of this group
175             */
176            @Override
177            public void setClassNameId(long classNameId);
178    
179            /**
180             * Returns the class p k of this group.
181             *
182             * @return the class p k of this group
183             */
184            @Override
185            public long getClassPK();
186    
187            /**
188             * Sets the class p k of this group.
189             *
190             * @param classPK the class p k of this group
191             */
192            @Override
193            public void setClassPK(long classPK);
194    
195            /**
196             * Returns the parent group ID of this group.
197             *
198             * @return the parent group ID of this group
199             */
200            public long getParentGroupId();
201    
202            /**
203             * Sets the parent group ID of this group.
204             *
205             * @param parentGroupId the parent group ID of this group
206             */
207            public void setParentGroupId(long parentGroupId);
208    
209            /**
210             * Returns the live group ID of this group.
211             *
212             * @return the live group ID of this group
213             */
214            public long getLiveGroupId();
215    
216            /**
217             * Sets the live group ID of this group.
218             *
219             * @param liveGroupId the live group ID of this group
220             */
221            public void setLiveGroupId(long liveGroupId);
222    
223            /**
224             * Returns the tree path of this group.
225             *
226             * @return the tree path of this group
227             */
228            @AutoEscape
229            public String getTreePath();
230    
231            /**
232             * Sets the tree path of this group.
233             *
234             * @param treePath the tree path of this group
235             */
236            public void setTreePath(String treePath);
237    
238            /**
239             * Returns the group key of this group.
240             *
241             * @return the group key of this group
242             */
243            @AutoEscape
244            public String getGroupKey();
245    
246            /**
247             * Sets the group key of this group.
248             *
249             * @param groupKey the group key of this group
250             */
251            public void setGroupKey(String groupKey);
252    
253            /**
254             * Returns the name of this group.
255             *
256             * @return the name of this group
257             */
258            public String getName();
259    
260            /**
261             * Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.
262             *
263             * @param locale the locale of the language
264             * @return the localized name of this group
265             */
266            @AutoEscape
267            public String getName(Locale locale);
268    
269            /**
270             * Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.
271             *
272             * @param locale the local of the language
273             * @param useDefault whether to use the default language if no localization exists for the requested language
274             * @return the localized name of this group. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
275             */
276            @AutoEscape
277            public String getName(Locale locale, boolean useDefault);
278    
279            /**
280             * Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.
281             *
282             * @param languageId the ID of the language
283             * @return the localized name of this group
284             */
285            @AutoEscape
286            public String getName(String languageId);
287    
288            /**
289             * Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.
290             *
291             * @param languageId the ID of the language
292             * @param useDefault whether to use the default language if no localization exists for the requested language
293             * @return the localized name of this group
294             */
295            @AutoEscape
296            public String getName(String languageId, boolean useDefault);
297    
298            @AutoEscape
299            public String getNameCurrentLanguageId();
300    
301            @AutoEscape
302            public String getNameCurrentValue();
303    
304            /**
305             * Returns a map of the locales and localized names of this group.
306             *
307             * @return the locales and localized names of this group
308             */
309            public Map<Locale, String> getNameMap();
310    
311            /**
312             * Sets the name of this group.
313             *
314             * @param name the name of this group
315             */
316            public void setName(String name);
317    
318            /**
319             * Sets the localized name of this group in the language.
320             *
321             * @param name the localized name of this group
322             * @param locale the locale of the language
323             */
324            public void setName(String name, Locale locale);
325    
326            /**
327             * Sets the localized name of this group in the language, and sets the default locale.
328             *
329             * @param name the localized name of this group
330             * @param locale the locale of the language
331             * @param defaultLocale the default locale
332             */
333            public void setName(String name, Locale locale, Locale defaultLocale);
334    
335            public void setNameCurrentLanguageId(String languageId);
336    
337            /**
338             * Sets the localized names of this group from the map of locales and localized names.
339             *
340             * @param nameMap the locales and localized names of this group
341             */
342            public void setNameMap(Map<Locale, String> nameMap);
343    
344            /**
345             * Sets the localized names of this group from the map of locales and localized names, and sets the default locale.
346             *
347             * @param nameMap the locales and localized names of this group
348             * @param defaultLocale the default locale
349             */
350            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
351    
352            /**
353             * Returns the description of this group.
354             *
355             * @return the description of this group
356             */
357            public String getDescription();
358    
359            /**
360             * Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.
361             *
362             * @param locale the locale of the language
363             * @return the localized description of this group
364             */
365            @AutoEscape
366            public String getDescription(Locale locale);
367    
368            /**
369             * Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.
370             *
371             * @param locale the local of the language
372             * @param useDefault whether to use the default language if no localization exists for the requested language
373             * @return the localized description of this group. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
374             */
375            @AutoEscape
376            public String getDescription(Locale locale, boolean useDefault);
377    
378            /**
379             * Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.
380             *
381             * @param languageId the ID of the language
382             * @return the localized description of this group
383             */
384            @AutoEscape
385            public String getDescription(String languageId);
386    
387            /**
388             * Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.
389             *
390             * @param languageId the ID of the language
391             * @param useDefault whether to use the default language if no localization exists for the requested language
392             * @return the localized description of this group
393             */
394            @AutoEscape
395            public String getDescription(String languageId, boolean useDefault);
396    
397            @AutoEscape
398            public String getDescriptionCurrentLanguageId();
399    
400            @AutoEscape
401            public String getDescriptionCurrentValue();
402    
403            /**
404             * Returns a map of the locales and localized descriptions of this group.
405             *
406             * @return the locales and localized descriptions of this group
407             */
408            public Map<Locale, String> getDescriptionMap();
409    
410            /**
411             * Sets the description of this group.
412             *
413             * @param description the description of this group
414             */
415            public void setDescription(String description);
416    
417            /**
418             * Sets the localized description of this group in the language.
419             *
420             * @param description the localized description of this group
421             * @param locale the locale of the language
422             */
423            public void setDescription(String description, Locale locale);
424    
425            /**
426             * Sets the localized description of this group in the language, and sets the default locale.
427             *
428             * @param description the localized description of this group
429             * @param locale the locale of the language
430             * @param defaultLocale the default locale
431             */
432            public void setDescription(String description, Locale locale,
433                    Locale defaultLocale);
434    
435            public void setDescriptionCurrentLanguageId(String languageId);
436    
437            /**
438             * Sets the localized descriptions of this group from the map of locales and localized descriptions.
439             *
440             * @param descriptionMap the locales and localized descriptions of this group
441             */
442            public void setDescriptionMap(Map<Locale, String> descriptionMap);
443    
444            /**
445             * Sets the localized descriptions of this group from the map of locales and localized descriptions, and sets the default locale.
446             *
447             * @param descriptionMap the locales and localized descriptions of this group
448             * @param defaultLocale the default locale
449             */
450            public void setDescriptionMap(Map<Locale, String> descriptionMap,
451                    Locale defaultLocale);
452    
453            /**
454             * Returns the type of this group.
455             *
456             * @return the type of this group
457             */
458            public int getType();
459    
460            /**
461             * Sets the type of this group.
462             *
463             * @param type the type of this group
464             */
465            public void setType(int type);
466    
467            /**
468             * Returns the type settings of this group.
469             *
470             * @return the type settings of this group
471             */
472            @AutoEscape
473            public String getTypeSettings();
474    
475            /**
476             * Sets the type settings of this group.
477             *
478             * @param typeSettings the type settings of this group
479             */
480            public void setTypeSettings(String typeSettings);
481    
482            /**
483             * Returns the manual membership of this group.
484             *
485             * @return the manual membership of this group
486             */
487            public boolean getManualMembership();
488    
489            /**
490             * Returns <code>true</code> if this group is manual membership.
491             *
492             * @return <code>true</code> if this group is manual membership; <code>false</code> otherwise
493             */
494            public boolean isManualMembership();
495    
496            /**
497             * Sets whether this group is manual membership.
498             *
499             * @param manualMembership the manual membership of this group
500             */
501            public void setManualMembership(boolean manualMembership);
502    
503            /**
504             * Returns the membership restriction of this group.
505             *
506             * @return the membership restriction of this group
507             */
508            public int getMembershipRestriction();
509    
510            /**
511             * Sets the membership restriction of this group.
512             *
513             * @param membershipRestriction the membership restriction of this group
514             */
515            public void setMembershipRestriction(int membershipRestriction);
516    
517            /**
518             * Returns the friendly u r l of this group.
519             *
520             * @return the friendly u r l of this group
521             */
522            @AutoEscape
523            public String getFriendlyURL();
524    
525            /**
526             * Sets the friendly u r l of this group.
527             *
528             * @param friendlyURL the friendly u r l of this group
529             */
530            public void setFriendlyURL(String friendlyURL);
531    
532            /**
533             * Returns the site of this group.
534             *
535             * @return the site of this group
536             */
537            public boolean getSite();
538    
539            /**
540             * Returns <code>true</code> if this group is site.
541             *
542             * @return <code>true</code> if this group is site; <code>false</code> otherwise
543             */
544            public boolean isSite();
545    
546            /**
547             * Sets whether this group is site.
548             *
549             * @param site the site of this group
550             */
551            public void setSite(boolean site);
552    
553            /**
554             * Returns the remote staging group count of this group.
555             *
556             * @return the remote staging group count of this group
557             */
558            public int getRemoteStagingGroupCount();
559    
560            /**
561             * Sets the remote staging group count of this group.
562             *
563             * @param remoteStagingGroupCount the remote staging group count of this group
564             */
565            public void setRemoteStagingGroupCount(int remoteStagingGroupCount);
566    
567            /**
568             * Returns the inherit content of this group.
569             *
570             * @return the inherit content of this group
571             */
572            public boolean getInheritContent();
573    
574            /**
575             * Returns <code>true</code> if this group is inherit content.
576             *
577             * @return <code>true</code> if this group is inherit content; <code>false</code> otherwise
578             */
579            public boolean isInheritContent();
580    
581            /**
582             * Sets whether this group is inherit content.
583             *
584             * @param inheritContent the inherit content of this group
585             */
586            public void setInheritContent(boolean inheritContent);
587    
588            /**
589             * Returns the active of this group.
590             *
591             * @return the active of this group
592             */
593            public boolean getActive();
594    
595            /**
596             * Returns <code>true</code> if this group is active.
597             *
598             * @return <code>true</code> if this group is active; <code>false</code> otherwise
599             */
600            public boolean isActive();
601    
602            /**
603             * Sets whether this group is active.
604             *
605             * @param active the active of this group
606             */
607            public void setActive(boolean active);
608    
609            @Override
610            public boolean isNew();
611    
612            @Override
613            public void setNew(boolean n);
614    
615            @Override
616            public boolean isCachedModel();
617    
618            @Override
619            public void setCachedModel(boolean cachedModel);
620    
621            @Override
622            public boolean isEscapedModel();
623    
624            @Override
625            public Serializable getPrimaryKeyObj();
626    
627            @Override
628            public void setPrimaryKeyObj(Serializable primaryKeyObj);
629    
630            @Override
631            public ExpandoBridge getExpandoBridge();
632    
633            @Override
634            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
635    
636            @Override
637            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
638    
639            @Override
640            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
641    
642            @Override
643            public String[] getAvailableLanguageIds();
644    
645            @Override
646            public String getDefaultLanguageId();
647    
648            @Override
649            public void prepareLocalizedFieldsForImport() throws LocaleException;
650    
651            @Override
652            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
653                    throws LocaleException;
654    
655            @Override
656            public Object clone();
657    
658            @Override
659            public int compareTo(com.liferay.portal.model.Group group);
660    
661            @Override
662            public int hashCode();
663    
664            @Override
665            public CacheModel<com.liferay.portal.model.Group> toCacheModel();
666    
667            @Override
668            public com.liferay.portal.model.Group toEscapedModel();
669    
670            @Override
671            public com.liferay.portal.model.Group toUnescapedModel();
672    
673            @Override
674            public String toString();
675    
676            @Override
677            public String toXmlString();
678    }