Package org.molgenis.api.metadata.v3

Interface MetadataApiService

All Known Implementing Classes:

MetadataApiServiceImpl

public interface MetadataApiService

Method Summary

Modifier and Type	Method	Description
void	createEntityType(EntityType entityType)
MetadataUpsertJobExecution	deleteAttributeAsync(String entityTypeId, String attributeId)	Deletes an Attribute asynchronously.
MetadataUpsertJobExecution	deleteAttributesAsync(String entityTypeId, Query query)	Deletes one or more Attributes asynchronously based on a query.
MetadataDeleteJobExecution	deleteEntityTypeAsync(String entityTypeId)	Deletes an EntityType asynchronously.
MetadataDeleteJobExecution	deleteEntityTypesAsync(Query query)	Deletes one or more EntityTypes asynchronously based on a query.
Attribute	findAttribute(String entityTypeId, String attributeId)
org.molgenis.api.metadata.v3.Attributes	findAttributes(String entityTypeId, Query query, Sort sort, int size, int page)
EntityType	findEntityType(String entityTypeId)
org.molgenis.api.metadata.v3.EntityTypes	findEntityTypes(Query query, Sort sort, int size, int page)
MetadataUpsertJobExecution	updateEntityTypeAsync(EntityType entityType)	Updates an EntityType asynchronously.

Method Detail

createEntityType

void createEntityType(EntityType entityType)

findEntityType

EntityType findEntityType(String entityTypeId)

Parameters:

entityTypeId - entity type identifier

Throws:

UnknownEntityTypeException - if not entity type exists for the given identifier

findEntityTypes

org.molgenis.api.metadata.v3.EntityTypes findEntityTypes(@Nullable @CheckForNull
                                                         Query query,
                                                         Sort sort,
                                                         int size,
                                                         int page)

findAttributes

org.molgenis.api.metadata.v3.Attributes findAttributes(String entityTypeId,
                                                       @Nullable @CheckForNull
                                                       Query query,
                                                       Sort sort,
                                                       int size,
                                                       int page)

findAttribute

Attribute findAttribute(String entityTypeId,
                        String attributeId)

Parameters:

entityTypeId - identifier of the EntityType

attributeId - identifier of the Attribute

Throws:

UnknownAttributeException - if no Attribute exists for the given identifier

UnknownEntityTypeException - if no EntityType exists for the given identifier

deleteAttributeAsync

MetadataUpsertJobExecution deleteAttributeAsync(String entityTypeId,
                                                String attributeId)

Deletes an Attribute asynchronously.

Parameters:

entityTypeId - identifier of the Attribute's EntityType

attributeId - identifier of the Attribute to delete

Returns:

a JobExecution describing the status of the job

Throws:

UnknownEntityTypeException - if no EntityType exists for the given identifier

UnknownAttributeException - if no Attribute exists for the given identifier or if the Attribute does not belong to the given EntityType

deleteAttributesAsync

MetadataUpsertJobExecution deleteAttributesAsync(String entityTypeId,
                                                 Query query)

Deletes one or more Attributes asynchronously based on a query.

Parameters:

entityTypeId - identifier of the Attribute's EntityType

query - a query that selects attributes

Returns:

a JobExecution describing the status of the job

Throws:

UnknownEntityTypeException - if no EntityType exists for the given identifier

deleteEntityTypeAsync

MetadataDeleteJobExecution deleteEntityTypeAsync(String entityTypeId)

Deletes an EntityType asynchronously.

Parameters:

entityTypeId - identifier of the Attribute's EntityType

Returns:

a JobExecution describing the status of the job

Throws:

UnknownEntityTypeException - if no EntityType exists for the given identifier

deleteEntityTypesAsync

MetadataDeleteJobExecution deleteEntityTypesAsync(Query query)

Deletes one or more EntityTypes asynchronously based on a query.

Returns:

a JobExecution describing the status of the job

updateEntityTypeAsync

MetadataUpsertJobExecution updateEntityTypeAsync(EntityType entityType)

Updates an EntityType asynchronously.

Parameters:

entityType - updated EntityType

Returns:

a JobExecution describing the status of the job