Package ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions

Class EntityWithPropertiesSortOptions<OBJECT extends ICodeHolder & IPermIdHolder & IRegistrationDateHolder & IModificationDateHolder & IPropertiesHolder>

java.lang.Object

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions.SortOptions<OBJECT>

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions.EntitySortOptions<OBJECT>

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions.EntityWithPropertiesSortOptions<OBJECT>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DataSetSortOptions, ExperimentSortOptions, MaterialSortOptions, SampleSortOptions

@JsonObject("as.dto.common.fetchoptions.EntityWithPropertiesSortOptions")
public class EntityWithPropertiesSortOptions<OBJECT extends ICodeHolder & IPermIdHolder & IRegistrationDateHolder & IModificationDateHolder & IPropertiesHolder>
extends EntitySortOptions<OBJECT>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ANY_PROPERTY_SCORE
static java.lang.String	FETCHED_FIELDS_SCORE
static java.lang.String	PROPERTY
static java.lang.String	PROPERTY_SCORE
static java.lang.String	TYPE

Fields inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions.EntitySortOptions

CODE, MODIFICATION_DATE, PERM_ID, REGISTRATION_DATE

Constructor Summary

Constructors

Constructor	Description
EntityWithPropertiesSortOptions()

Method Summary

Modifier and Type	Method	Description
SortOrder	fetchedFieldsScore()	Deprecated. queries cannot specify sorting by score.
SortOrder	getFetchedFieldsScore()
SortOrder	getProperty(java.lang.String propertyName)
SortOrder	getType()
SortOrder	property(java.lang.String propertyName)
SortOrder	stringMatchAnyPropertyScore(java.lang.String propertyValue)
SortOrder	stringMatchPropertyScore(java.lang.String propertyName, java.lang.String propertyValue)
SortOrder	stringPrefixMatchAnyPropertyScore(java.lang.String propertyValue)
SortOrder	stringPrefixMatchPropertyScore(java.lang.String propertyName, java.lang.String propertyValue)
SortOrder	type()

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions.EntitySortOptions

code, getCode, getModificationDate, getPermId, getRegistrationDate, modificationDate, permId, registrationDate

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.fetchoptions.SortOptions

getOrCreateSorting, getOrCreateSortingWithParameters, getSorting, getSortings, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FETCHED_FIELDS_SCORE

public static final java.lang.String FETCHED_FIELDS_SCORE

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

PROPERTY

public static final java.lang.String PROPERTY

See Also:

Constant Field Values

PROPERTY_SCORE

public static final java.lang.String PROPERTY_SCORE

See Also:

Constant Field Values

ANY_PROPERTY_SCORE

public static final java.lang.String ANY_PROPERTY_SCORE

See Also:

Constant Field Values

Constructor Detail

EntityWithPropertiesSortOptions

public EntityWithPropertiesSortOptions()

Method Detail

fetchedFieldsScore

@Deprecated
public SortOrder fetchedFieldsScore()

Deprecated.

queries cannot specify sorting by score.

Returns:

getFetchedFieldsScore

public SortOrder getFetchedFieldsScore()

type

public SortOrder type()

getType

public SortOrder getType()

property

public SortOrder property(java.lang.String propertyName)

getProperty

public SortOrder getProperty(java.lang.String propertyName)

stringMatchPropertyScore

public SortOrder stringMatchPropertyScore(java.lang.String propertyName,
                                          java.lang.String propertyValue)

stringPrefixMatchPropertyScore

public SortOrder stringPrefixMatchPropertyScore(java.lang.String propertyName,
                                                java.lang.String propertyValue)

stringMatchAnyPropertyScore

public SortOrder stringMatchAnyPropertyScore(java.lang.String propertyValue)

stringPrefixMatchAnyPropertyScore

public SortOrder stringPrefixMatchAnyPropertyScore(java.lang.String propertyValue)