Interface EntityArgService<T extends Identifiable, S extends FilteringService<T>>

All Known Implementing Classes:

AbstractEntityArgService, CompositeSequenceArgService, DatabaseEntryArgService, DatasetArgService, ExpressionAnalysisResultSetArgService, GeneArgService, PlatformArgService, QuantitationTypeArgService, TaxonArgService

public interface EntityArgService<T extends Identifiable, S extends FilteringService<T>>

Bridges Arg operating on entities with their corresponding FilteringService.

Method Summary

Modifier and Type	Method	Description
Class<? extends T>	getElementClass()
List<T>	getEntities(AbstractEntityArg<?,T,S> entityArg)	Retrieve the entities represented by this argument.
List<T>	getEntities(AbstractEntityArrayArg<T,S> entitiesArg)	Retrieve each entity represented by the array argument, raising a NotFoundException if any of them is missing.
T	getEntity(AbstractEntityArg<?,T,S> entityArg)	Retrieve the entity represented by this argument.
Set<String>	getFilterableProperties()
List<Object>	getFilterablePropertyAllowedValues(String p)
Collection<org.springframework.security.access.ConfigAttribute>	getFilterablePropertyConfigAttributes(String roles)
String	getFilterablePropertyDescription(String p)
List<org.springframework.context.MessageSourceResolvable>	getFilterablePropertyResolvableAllowedValuesLabels(String p)
Class<?>	getFilterablePropertyType(String p)
<A> Filters	getFilters(AbstractEntityArg<A,T,S> entityArg)	Translate the provided entity argument into a Filters.
Filters	getFilters(AbstractEntityArrayArg<T,S> entitiesArg)	Translate the provided entity argument into a Filters.
Filters	getFilters(FilterArg<T> filterArg)	Obtain a Filters from a filter argument.
Sort	getSort(SortArg<T> sortArg)	Obtain a Sort from a sort argument.
boolean	isFilterablePropertyDeprecated(String p)
boolean	isFilterablePropertyUsingSubquery(String p)

Method Details

getElementClass

Class<? extends T> getElementClass()

See Also:

• BaseReadOnlyService.getElementClass()

getFilterableProperties

Set<String> getFilterableProperties()

See Also:

• FilteringService.getFilterableProperties()

getFilterablePropertyType

Class<?> getFilterablePropertyType(String p)

See Also:

• FilteringService.getFilterablePropertyType(String)

getFilterablePropertyDescription

String getFilterablePropertyDescription(String p)

See Also:

• FilteringService.getFilterablePropertyDescription(String)

getFilterablePropertyAllowedValues

List<Object> getFilterablePropertyAllowedValues(String p)

See Also:

• FilteringService.getFilterablePropertyAllowedValues(String)

isFilterablePropertyUsingSubquery

boolean isFilterablePropertyUsingSubquery(String p)

See Also:

• FilteringService.isFilterablePropertyUsingSubquery(String)

isFilterablePropertyDeprecated

boolean isFilterablePropertyDeprecated(String p)

See Also:

• FilteringService.isFilterablePropertyDeprecated(String)

getFilterablePropertyConfigAttributes

Collection<org.springframework.security.access.ConfigAttribute> getFilterablePropertyConfigAttributes(String roles)

See Also:

• FilteringService.getFilterablePropertyConfigAttributes(String)

getFilterablePropertyResolvableAllowedValuesLabels

List<org.springframework.context.MessageSourceResolvable> getFilterablePropertyResolvableAllowedValuesLabels(String p)
                                                                                                      throws jakarta.ws.rs.BadRequestException

Throws:

jakarta.ws.rs.BadRequestException

See Also:

• FilteringService.getFilterablePropertyResolvableAllowedValuesLabels(String)

getEntity

@NonNull
T getEntity(AbstractEntityArg<?,T,S> entityArg)
     throws jakarta.ws.rs.NotFoundException,
jakarta.ws.rs.BadRequestException

Retrieve the entity represented by this argument.

Throws:

jakarta.ws.rs.NotFoundException - if the entity does not exist

jakarta.ws.rs.BadRequestException - if the argument is malformed

getEntities

List<T> getEntities(AbstractEntityArg<?,T,S> entityArg)
             throws jakarta.ws.rs.NotFoundException,
jakarta.ws.rs.BadRequestException

Retrieve the entities represented by this argument.

Note that this will never return an empty array.

This is intended for cases where an argument could match more than one entity.

Throws:

jakarta.ws.rs.NotFoundException - if no entity matching the argument exist

jakarta.ws.rs.BadRequestException - if the argument is malformed

getEntities

List<T> getEntities(AbstractEntityArrayArg<T,S> entitiesArg)
             throws jakarta.ws.rs.NotFoundException,
jakarta.ws.rs.BadRequestException

Retrieve each entity represented by the array argument, raising a NotFoundException if any of them is missing.

Throws:

jakarta.ws.rs.NotFoundException - if any entity is missing

jakarta.ws.rs.BadRequestException - if the argument is malformed

getFilters

<A> Filters getFilters(AbstractEntityArg<A,T,S> entityArg)
                throws jakarta.ws.rs.BadRequestException

Translate the provided entity argument into a Filters.

This will generate clause in the form of property = value.

Throws:

jakarta.ws.rs.BadRequestException - if the argument is malformed

getFilters

Filters getFilters(AbstractEntityArrayArg<T,S> entitiesArg)
            throws jakarta.ws.rs.BadRequestException

Translate the provided entity argument into a Filters.

This will generate clause in the form of property in (values...).

Throws:

jakarta.ws.rs.BadRequestException - if the argument is malformed

getFilters

Filters getFilters(FilterArg<T> filterArg)
            throws jakarta.ws.rs.BadRequestException

Obtain a Filters from a filter argument.

Throws:

jakarta.ws.rs.BadRequestException - if the argument is malformed

getSort

Sort getSort(SortArg<T> sortArg)
      throws jakarta.ws.rs.BadRequestException

Obtain a Sort from a sort argument.

Throws:

jakarta.ws.rs.BadRequestException - if the argument is malformed