com.attivio.sdk.businesscenter

Class AdminQuery

java.lang.Object

com.attivio.sdk.businesscenter.AdminQuery

All Implemented Interfaces:

Serializable, Cloneable

public class AdminQuery
extends Object
implements Cloneable, Serializable

Query for performing queries for administration purposes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdminQuery.Facet
static class	AdminQuery.Filter Filter specifier for a dictionary query.
static class	AdminQuery.Sort Sort specifier for a dictionary query.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAMPAIGN_FIELD Field for filtering by campaign.
static String	CHANGE_STATUS_FIELD Field for filtering by status
static String	DEFAULT_LOCALE_FIELD Field for sorting search profiles by default locale.
static String	DICTIONARY_ENTRY_ID_FIELD Field for filtering on dictionary entry id.
static String	DICTIONARY_GROUP_FIELD Field for filtering on dictionary group.
static String	DICTIONARY_LOCALE_FIELD Field for filtering on dictionary locale.
static String	DICTIONARY_NAME_FIELD Field for filtering on dictionary name.
static String	DICTIONARY_TERM_FIELD Field for sorting on dictionary term.
static String	DICTIONARY_TYPE_FIELD Field for filtering on dictionary type.
static String	DOCID_FIELD Field for filtering on document id.
static String	LAST_APPROVED_FIELD Field for sorting on last approved time.
static String	LAST_MODIFIED_FIELD Field for sorting on last modified time.
static String	LAST_PUBLISHED_FIELD Field for sorting on last published time.
static String	QUERY_ID_FIELD Field for filtering by query id.
static String	SEARCH_PROFILE_FIELD Field for filtering by search profile name.
static String	SITE_FIELD Field for filtering search profiles by site.

Constructor Summary

Constructors

Constructor and Description
AdminQuery()
AdminQuery(DictionaryInfo info) Template an administration query based on info.

Method Summary

Modifier and Type	Method and Description
void	addFacet(AdminQuery.Facet value)
void	addFilter(ChangeStatus status)
void	addFilter(DictionaryType type)
void	addFilter(String field, Locale... values)
void	addFilter(String field, Locale value)
void	addFilter(String field, String... values)
void	addVersion(RevisionStatus value)
AdminQuery	clone()
boolean	equals(Object other)
List<AdminQuery.Facet>	getFacets()
List<AdminQuery.Filter>	getFilters()
String	getQuery()
List<AdminQuery.Sort>	getSort()
Set<RevisionStatus>	getVersion()
int	hashCode()
void	setFacets(List<AdminQuery.Facet> value)
void	setFilters(List<AdminQuery.Filter> value)
void	setQuery(String value)
void	setSort(AdminQuery.Sort... value)
void	setSort(List<AdminQuery.Sort> value)
void	setVersion(RevisionStatus... value)
void	setVersion(Set<RevisionStatus> value)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

SITE_FIELD

public static final String SITE_FIELD

Field for filtering search profiles by site.

See Also:

Constant Field Values

SEARCH_PROFILE_FIELD

public static final String SEARCH_PROFILE_FIELD

Field for filtering by search profile name.

See Also:

Constant Field Values

CAMPAIGN_FIELD

public static final String CAMPAIGN_FIELD

Field for filtering by campaign.

See Also:

Constant Field Values

QUERY_ID_FIELD

public static final String QUERY_ID_FIELD

Field for filtering by query id.

See Also:

Constant Field Values

CHANGE_STATUS_FIELD

public static final String CHANGE_STATUS_FIELD

Field for filtering by status

See Also:

Constant Field Values

DICTIONARY_TYPE_FIELD

public static final String DICTIONARY_TYPE_FIELD

Field for filtering on dictionary type.

See Also:

Constant Field Values

DICTIONARY_NAME_FIELD

public static final String DICTIONARY_NAME_FIELD

Field for filtering on dictionary name.

See Also:

Constant Field Values

DICTIONARY_GROUP_FIELD

public static final String DICTIONARY_GROUP_FIELD

Field for filtering on dictionary group.

See Also:

Constant Field Values

DICTIONARY_ENTRY_ID_FIELD

public static final String DICTIONARY_ENTRY_ID_FIELD

Field for filtering on dictionary entry id.

See Also:

Constant Field Values

LAST_MODIFIED_FIELD

public static final String LAST_MODIFIED_FIELD

Field for sorting on last modified time.

See Also:

Constant Field Values

LAST_APPROVED_FIELD

public static final String LAST_APPROVED_FIELD

Field for sorting on last approved time.

See Also:

Constant Field Values

LAST_PUBLISHED_FIELD

public static final String LAST_PUBLISHED_FIELD

Field for sorting on last published time.

See Also:

Constant Field Values

DICTIONARY_LOCALE_FIELD

public static final String DICTIONARY_LOCALE_FIELD

Field for filtering on dictionary locale.

See Also:

Constant Field Values

DICTIONARY_TERM_FIELD

public static final String DICTIONARY_TERM_FIELD

Field for sorting on dictionary term.

See Also:

Constant Field Values

DOCID_FIELD

public static final String DOCID_FIELD

Field for filtering on document id.

See Also:

Constant Field Values

DEFAULT_LOCALE_FIELD

public static final String DEFAULT_LOCALE_FIELD

Field for sorting search profiles by default locale.

See Also:

Constant Field Values

Constructor Detail

AdminQuery

public AdminQuery()

AdminQuery

public AdminQuery(DictionaryInfo info)

Template an administration query based on info.

Method Detail

getQuery

public String getQuery()

setQuery

public void setQuery(String value)

getFacets

public List<AdminQuery.Facet> getFacets()

setFacets

public void setFacets(List<AdminQuery.Facet> value)

addFacet

public void addFacet(AdminQuery.Facet value)

getFilters

public List<AdminQuery.Filter> getFilters()

setFilters

public void setFilters(List<AdminQuery.Filter> value)

addFilter

public void addFilter(String field,
                      String... values)

addFilter

public void addFilter(String field,
                      Locale value)

addFilter

public void addFilter(String field,
                      Locale... values)

addFilter

public void addFilter(DictionaryType type)

addFilter

public void addFilter(ChangeStatus status)

getSort

public List<AdminQuery.Sort> getSort()

setSort

public void setSort(List<AdminQuery.Sort> value)

setSort

public void setSort(AdminQuery.Sort... value)

getVersion

public Set<RevisionStatus> getVersion()

setVersion

public void setVersion(Set<RevisionStatus> value)

setVersion

public void setVersion(RevisionStatus... value)

addVersion

public void addVersion(RevisionStatus value)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

clone

public AdminQuery clone()

Overrides:

clone in class Object