Package de.elo.ix.client.esearch.query

Enum Class SearchFieldE

java.lang.Object

java.lang.Enum<SearchFieldE>

de.elo.ix.client.esearch.query.SearchFieldE

All Implemented Interfaces:

Serializable, Comparable<SearchFieldE>, Constable

public enum SearchFieldE
extends Enum<SearchFieldE>
implements Serializable

Use this class of constants to define in which field should be searched or aggregated.

For every option, allowed FieldTypeE is given which is also the fallback type if provided type is incorrect.

Since:

11.00.000.013

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
DELETED_DATE	Expiration date
DOCUMENT_SIZE	document size
EXTRA_TEXT	Extra text
FEED_AUTHOR	ID of author
FEED_DATE_CREATED	Create dates of feed actions
FEED_DATE_UPDATED	Last update dates of feed actions
FEED_HASHTAG	Feed's Hashtags
FEED_MENTION	Mention of other users
FEED_REFERENCE	GUID of referenced sord
FEED_TEXT	Contains all feed text including hashtags, mentions and references
FEED_TYPE	Feed type as String
FILE_EXTENSION	file extension
FILENAME	file name
FULLTEXT	fulltext content
GUID	GUID
I_DATE	internal date
INDEXFIELD	Use this constant if a index field is searched/aggregated.
MASK_ID	mask id
MASK_NAME	mask name
OBJ_ID	Object id
OWNER_ID	ID of sord's creator
OWNER_NAME	Name of sord's creator
PARENT_GUID	parent guid
SORD_HASH	Hash value based on Sord's parameters indexed in iSearch For internal use only
SPACE_GUIDS	GUID of workspaces.
TIMESTAMP	Time of sord's last change
TITLE	sord's short name
TYPE	sord's type
VERSION_COMMENT	all version comments
VERSION_NUMBER	all version numbers
VERSION_OWNER_ID	all version's creators
X_DATE	external date

Method Summary

Modifier and Type	Method	Description
static SearchFieldE	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchFieldE[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INDEXFIELD

public static final SearchFieldE INDEXFIELD

Use this constant if a index field is searched/aggregated.

Submit name of indexfield by QueryFilter.indexFieldKey

Depending on type of the corresponding DocMaskLine/AspectLine (type field}, the corresponding FieldTypeE can be used.
DocMaskLines/AspectLines of type RELATION can be used with FieldTypeE.tokenized or FieldTypeE.notTokenized to search for the short name (Sord.name of the related Sord), or FieldTypeE.guid to search for the GUID of the related Sord.

OBJ_ID

public static final SearchFieldE OBJ_ID

Object id

Must be combined with FieldTypeE.numeric

See Also:

• Sord.id

GUID

public static final SearchFieldE GUID

GUID

Must be combined with FieldTypeE.notTokenized

See Also:

• Sord.guid

TITLE

public static final SearchFieldE TITLE

sord's short name

Must be combined with FieldTypeE.tokenized

See Also:

• Sord.name

FULLTEXT

public static final SearchFieldE FULLTEXT

fulltext content

Must be combined with FieldTypeE.tokenized

EXTRA_TEXT

public static final SearchFieldE EXTRA_TEXT

Extra text

Must be combined with FieldTypeE.tokenized

See Also:

• Sord.desc

OWNER_ID

public static final SearchFieldE OWNER_ID

ID of sord's creator

Must be combined with FieldTypeE.numeric

See Also:

• Sord.ownerId

OWNER_NAME

public static final SearchFieldE OWNER_NAME

Name of sord's creator

Must be combined with either FieldTypeE.tokenized or FieldTypeE.notTokenized

See Also:

• Sord.ownerName

FILE_EXTENSION

public static final SearchFieldE FILE_EXTENSION

file extension

Must be combined with FieldTypeE.notTokenized

See Also:

• DocVersion.ext

FILENAME

public static final SearchFieldE FILENAME

file name

Must be combined with either FieldTypeE.tokenized or FieldTypeE.notTokenized Important: This field is reserved for internal use. Do not use in queries and filters.

See Also:

• DocMaskLineC.NAME_FILENAME

TIMESTAMP

public static final SearchFieldE TIMESTAMP

Time of sord's last change

Value is not always synchronized with DB because Sord.TStamp is updated by changes not relevant for iSearch.

Must be combined with FieldTypeE.date

See Also:

• Sord.TStamp

I_DATE

public static final SearchFieldE I_DATE

internal date

Must be combined with FieldTypeE.date

See Also:

• Sord.IDateIso

X_DATE

public static final SearchFieldE X_DATE

external date

Must be combined with FieldTypeE.date

See Also:

• Sord.XDateIso

DELETED_DATE

public static final SearchFieldE DELETED_DATE

Expiration date

Must be combined with FieldTypeE.date

See Also:

• Sord.delDateIso

DOCUMENT_SIZE

public static final SearchFieldE DOCUMENT_SIZE

document size

Must be combined with FieldTypeE.numeric

See Also:

• DocVersion.size

MASK_ID

public static final SearchFieldE MASK_ID

mask id

Must be combined with FieldTypeE.numeric

See Also:

• Sord.mask

MASK_NAME

public static final SearchFieldE MASK_NAME

mask name

Must be combined with either FieldTypeE.tokenized or FieldTypeE.notTokenized

See Also:

• Sord.maskName

TYPE

public static final SearchFieldE TYPE

sord's type

Must be combined with FieldTypeE.numeric

See Also:

• Sord.type

PARENT_GUID

public static final SearchFieldE PARENT_GUID

parent guid

Must be combined with FieldTypeE.notTokenized

See Also:

• Sord.parentIds

VERSION_NUMBER

public static final SearchFieldE VERSION_NUMBER

all version numbers

Must be combined with either FieldTypeE.tokenized or FieldTypeE.notTokenized

See Also:

• DocVersion.version

VERSION_COMMENT

public static final SearchFieldE VERSION_COMMENT

all version comments

Must be combined with FieldTypeE.tokenized

See Also:

• DocVersion.comment

VERSION_OWNER_ID

public static final SearchFieldE VERSION_OWNER_ID

all version's creators

Must be combined with FieldTypeE.numeric

See Also:

• DocVersion.ownerId

FEED_TEXT

public static final SearchFieldE FEED_TEXT

Contains all feed text including hashtags, mentions and references

Must be combined with FieldTypeE.tokenized

FEED_AUTHOR

public static final SearchFieldE FEED_AUTHOR

ID of author

Must be combined with FieldTypeE.numeric

FEED_HASHTAG

public static final SearchFieldE FEED_HASHTAG

Feed's Hashtags

Must be combined with either FieldTypeE.tokenized or FieldTypeE.notTokenized

FEED_MENTION

public static final SearchFieldE FEED_MENTION

Mention of other users

Must be combined with FieldTypeE.notTokenized

FEED_REFERENCE

public static final SearchFieldE FEED_REFERENCE

GUID of referenced sord

Must be combined with FieldTypeE.notTokenized

FEED_TYPE

public static final SearchFieldE FEED_TYPE

Feed type as String

Must be combined with FieldTypeE.notTokenized

See Also:

• EActionType

FEED_DATE_CREATED

public static final SearchFieldE FEED_DATE_CREATED

Create dates of feed actions

Must be combined with FieldTypeE.date

FEED_DATE_UPDATED

public static final SearchFieldE FEED_DATE_UPDATED

Last update dates of feed actions

Must be combined with FieldTypeE.date

SORD_HASH

public static final SearchFieldE SORD_HASH

Hash value based on Sord's parameters indexed in iSearch For internal use only

Since:

12.00.000.041

SPACE_GUIDS

public static final SearchFieldE SPACE_GUIDS

GUID of workspaces.

If the sord belongs to a workspace, this value contains the GUID of that workspace as well as the GUIDs of parent workspaces and workspaces of references.

Must be combined with FieldTypeE.notTokenized

Since:

21.03.000.008

See Also:

• Sord.spaceGuid
• Sord.spaceGuids

Method Details

values

public static SearchFieldE[] 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 SearchFieldE 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