Package org.opencms.ade.galleries.shared
Enum CmsGallerySearchScope
- java.lang.Object
-
- java.lang.Enum<CmsGallerySearchScope>
-
- org.opencms.ade.galleries.shared.CmsGallerySearchScope
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<CmsGallerySearchScope>
public enum CmsGallerySearchScope extends java.lang.Enum<CmsGallerySearchScope>
An enum that represents the possible search scope choices in the ADE gallery search tab.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description everything
Search everything.shared
Search only in the shared folder.site
Search in the current site.siteShared
Search in the current site and the shared folder.subSite
Search in the current subsite.subSiteShared
Search in the current subsite and the shared folder.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getKey()
Returns the localization key for the choice.boolean
isIncludeShared()
Returns if this search scope includes the shared folder.boolean
isIncludeSite()
Returns if this search scope includes the site folder.boolean
isIncludeSubSite()
Returns if this search scope includes the sub site folder.static CmsGallerySearchScope
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CmsGallerySearchScope[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
everything
public static final CmsGallerySearchScope everything
Search everything.
-
shared
public static final CmsGallerySearchScope shared
Search only in the shared folder.
-
site
public static final CmsGallerySearchScope site
Search in the current site.
-
siteShared
public static final CmsGallerySearchScope siteShared
Search in the current site and the shared folder.
-
subSite
public static final CmsGallerySearchScope subSite
Search in the current subsite.
-
subSiteShared
public static final CmsGallerySearchScope subSiteShared
Search in the current subsite and the shared folder.
-
-
Method Detail
-
values
public static CmsGallerySearchScope[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CmsGallerySearchScope c : CmsGallerySearchScope.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CmsGallerySearchScope valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getKey
public java.lang.String getKey()
Returns the localization key for the choice.- Returns:
- the localization key for the choice
-
isIncludeShared
public boolean isIncludeShared()
Returns if this search scope includes the shared folder.- Returns:
true
if this search scope includes the shared folder
-
isIncludeSite
public boolean isIncludeSite()
Returns if this search scope includes the site folder.- Returns:
true
if this search scope includes the site folder
-
isIncludeSubSite
public boolean isIncludeSubSite()
Returns if this search scope includes the sub site folder.- Returns:
true
if this search scope includes the sub site folder
-
-