Package com.mypurecloud.sdk.v2.model

Enum Class KnowledgeDocumentQuery.IncludeVariationsEnum

java.lang.Object

java.lang.Enum<KnowledgeDocumentQuery.IncludeVariationsEnum>

com.mypurecloud.sdk.v2.model.KnowledgeDocumentQuery.IncludeVariationsEnum

All Implemented Interfaces:

Serializable, Comparable<KnowledgeDocumentQuery.IncludeVariationsEnum>, java.lang.constant.Constable

Enclosing class:

KnowledgeDocumentQuery

public static enum KnowledgeDocumentQuery.IncludeVariationsEnum
extends Enum<KnowledgeDocumentQuery.IncludeVariationsEnum>

Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
ALLMATCHING
OUTDATEDSDKVERSION
SINGLEMOSTRELEVANT

Method Summary

Modifier and Type	Method	Description
static KnowledgeDocumentQuery.IncludeVariationsEnum	fromString(String key)
String	toString()
static KnowledgeDocumentQuery.IncludeVariationsEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KnowledgeDocumentQuery.IncludeVariationsEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OUTDATEDSDKVERSION

public static final KnowledgeDocumentQuery.IncludeVariationsEnum OUTDATEDSDKVERSION

ALL

public static final KnowledgeDocumentQuery.IncludeVariationsEnum ALL

ALLMATCHING

public static final KnowledgeDocumentQuery.IncludeVariationsEnum ALLMATCHING

SINGLEMOSTRELEVANT

public static final KnowledgeDocumentQuery.IncludeVariationsEnum SINGLEMOSTRELEVANT

Method Details

values

public static KnowledgeDocumentQuery.IncludeVariationsEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static KnowledgeDocumentQuery.IncludeVariationsEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static KnowledgeDocumentQuery.IncludeVariationsEnum fromString(String key)

toString

public String toString()

Overrides:

toString in class Enum<KnowledgeDocumentQuery.IncludeVariationsEnum>