Package org.neotropic.kuwaiba.northbound.rest.mem

Interface MetadataEntityManagerRestOpenApi

  • All Known Implementing Classes:
    MetadataEntityManagerRestController
    @RequestMapping("/v2.1.1/core/mem/")
public interface MetadataEntityManagerRestOpenApi
    Swagger documentation for Metadata Entity Manager.
    Author:
    Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

    • Method Detail

      • createClass

        @RequestMapping(method=POST,
                value="createClass/{sessionId}",
                produces="application/json")
long createClass​(@Valid @RequestBody
                 @Valid ClassMetadata classDefinition,
                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                 @NotNull @Valid String sessionId)

      • setClassProperties

        @RequestMapping(method=PUT,
                value="setClassProperties/{classId}/{sessionId}",
                produces="application/json")
ChangeDescriptor setClassProperties​(@NotNull @Valid @PathVariable(value="classId",required=true)
                                    @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                                    @Valid @RequestBody
                                    @Valid HashMap<String,​Object> properties,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)

      • deleteClass

        @RequestMapping(method=DELETE,
                value="deleteClass/{className}/{sessionId}",
                produces="application/json")
void deleteClass​(@NotNull @Valid @PathVariable(value="className",required=true)
                 @NotNull @Valid String className,
                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                 @NotNull @Valid String sessionId)

      • deleteClassWithId

        @RequestMapping(method=DELETE,
                value="deleteClassWithId/{classId}/{sessionId}",
                produces="application/json")
void deleteClassWithId​(@NotNull @Valid @PathVariable(value="classId",required=true)
                       @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                       @NotNull @Valid String sessionId)

      • getAllClassesLight

        @RequestMapping(method=GET,
                value="getAllClassesLight/{includeListTypes}/{includeIndesign}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getAllClassesLight​(@NotNull @Valid @PathVariable(value="includeListTypes",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeListTypes,
                                            @NotNull @Valid @PathVariable(value="includeIndesign",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeIndesign,
                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                            @NotNull @Valid String sessionId)

      • getSubClassesLight

        @RequestMapping(method=GET,
                value="getSubClassesLight/{className}/{includeAbstractClasses}/{includeSelf}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getSubClassesLight​(@NotNull @Valid @PathVariable(value="className",required=true)
                                            @NotNull @Valid String className,
                                            @NotNull @Valid @PathVariable(value="includeAbstractClasses",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeAbstractClasses,
                                            @NotNull @Valid @PathVariable(value="includeSelf",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeSelf,
                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                            @NotNull @Valid String sessionId)

      • getSubClassesLightNoRecursive

        @RequestMapping(method=GET,
                value="getSubClassesLightNoRecursive/{className}/{includeAbstractClasses}/{includeSelf}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getSubClassesLightNoRecursive​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                       @NotNull @Valid String className,
                                                       @NotNull @Valid @PathVariable(value="includeAbstractClasses",required=true)
                                                       @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeAbstractClasses,
                                                       @NotNull @Valid @PathVariable(value="includeSelf",required=true)
                                                       @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeSelf,
                                                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                       @NotNull @Valid String sessionId)

      • getSuperClassesLight

        @RequestMapping(method=GET,
                value="getSuperClassesLight/{className}/{includeSelf}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getSuperClassesLight​(@NotNull @Valid @PathVariable(value="className",required=true)
                                              @NotNull @Valid String className,
                                              @NotNull @Valid @PathVariable(value="includeSelf",required=true)
                                              @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeSelf,
                                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                              @NotNull @Valid String sessionId)

      • getSubClassesCount

        @RequestMapping(method=GET,
                value="getSubClassesCount/{className}/{sessionId}",
                produces="application/json")
long getSubClassesCount​(@NotNull @Valid @PathVariable(value="className",required=true)
                        @NotNull @Valid String className,
                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                        @NotNull @Valid String sessionId)

      • getAllClasses

        @RequestMapping(method=GET,
                value="getAllClasses/{includeListTypes}/{includeIndesign}/{sessionId}",
                produces="application/json")
List<ClassMetadata> getAllClasses​(@NotNull @Valid @PathVariable(value="includeListTypes",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeListTypes,
                                  @NotNull @Valid @PathVariable(value="includeIndesign",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeIndesign,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

      • getClass

        @RequestMapping(method=GET,
                value="getClass/{className}/{sessionId}",
                produces="application/json")
ClassMetadata getClass​(@NotNull @Valid @PathVariable(value="className",required=true)
                       @NotNull @Valid String className,
                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                       @NotNull @Valid String sessionId)

      • getClassWithId

        @RequestMapping(method=GET,
                value="getClassWithId/{classId}/{sessionId}",
                produces="application/json")
ClassMetadata getClassWithId​(@NotNull @Valid @PathVariable(value="classId",required=true)
                             @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                             @NotNull @Valid String sessionId)

      • getClasses

        @RequestMapping(method=GET,
                value="getClasses/{className}/{page}/{limit}/{sessionId}",
                produces="application/json")
List<ClassMetadata> getClasses​(@NotNull @Valid @PathVariable(value="className",required=true)
                               @NotNull @Valid String className,
                               @NotNull @Valid @PathVariable(value="page",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid int page,
                               @NotNull @Valid @PathVariable(value="limit",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

      • isSubclassOf

        @RequestMapping(method=GET,
                value="isSubclassOf/{allegedParent}/{className}/{sessionId}",
                produces="application/json")
boolean isSubclassOf​(@NotNull @Valid @PathVariable(value="allegedParent",required=true)
                     @NotNull @Valid String allegedParent,
                     @NotNull @Valid @PathVariable(value="className",required=true)
                     @NotNull @Valid String className,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

      • createAttribute

        @RequestMapping(method=POST,
                value="createAttribute/{className}/{recursive}/{sessionId}",
                produces="application/json")
void createAttribute​(@NotNull @Valid @PathVariable(value="className",required=true)
                     @NotNull @Valid String className,
                     @Valid @RequestBody
                     @Valid AttributeMetadata attributeDefinition,
                     @NotNull @Valid @PathVariable(value="recursive",required=true)
                     @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

      • createAttributeForClassWithId

        @RequestMapping(method=POST,
                value="createAttributeForClassWithId/{classId}/{sessionId}",
                produces="application/json")
void createAttributeForClassWithId​(@NotNull @Valid @PathVariable(value="classId",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                                   @Valid @RequestBody
                                   @Valid AttributeMetadata attributeDefinition,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)

      • hasAttribute

        @RequestMapping(method=GET,
                value="hasAttribute/{className}/{name}/{sessionId}",
                produces="application/json")
boolean hasAttribute​(@NotNull @Valid @PathVariable(value="className",required=true)
                     @NotNull @Valid String className,
                     @NotNull @Valid @PathVariable(value="name",required=true)
                     @NotNull @Valid String name,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

      • getAttribute

        @RequestMapping(method=GET,
                value="getAttribute/{className}/{name}/{sessionId}",
                produces="application/json")
AttributeMetadata getAttribute​(@NotNull @Valid @PathVariable(value="className",required=true)
                               @NotNull @Valid String className,
                               @NotNull @Valid @PathVariable(value="name",required=true)
                               @NotNull @Valid String name,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

      • getAttributeForClassWithId

        @RequestMapping(method=GET,
                value="getAttributeForClassWithId/{classId}/{id}/{sessionId}",
                produces="application/json")
AttributeMetadata getAttributeForClassWithId​(@NotNull @Valid @PathVariable(value="classId",required=true)
                                             @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                                             @NotNull @Valid @PathVariable(value="id",required=true)
                                             @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                             @NotNull @Valid String sessionId)

      • getMandatoryAttributesInClass

        @RequestMapping(method=GET,
                value="getMandatoryAttributesInClass/{className}/{sessionId}",
                produces="application/json")
List<AttributeMetadata> getMandatoryAttributesInClass​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                      @NotNull @Valid String className,
                                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                      @NotNull @Valid String sessionId)

      • setAttributeProperties

        @RequestMapping(method=PUT,
                value="setAttributeProperties/{className}/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor setAttributeProperties​(@NotNull @Valid @PathVariable(value="className",required=true)
                                        @NotNull @Valid String className,
                                        @NotNull @Valid @PathVariable(value="id",required=true)
                                        @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                        @Valid @RequestBody
                                        @Valid HashMap<String,​Object> properties,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)

      • setAttributePropertiesForClassWithId

        @RequestMapping(method=PUT,
                value="setAttributePropertiesForClassWithId/{classId}/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor setAttributePropertiesForClassWithId​(@NotNull @Valid @PathVariable(value="classId",required=true)
                                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                                                      @NotNull @Valid @PathVariable(value="id",required=true)
                                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                                      @Valid @RequestBody
                                                      @Valid HashMap<String,​Object> properties,
                                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                      @NotNull @Valid String sessionId)

      • deleteAttribute

        @RequestMapping(method=DELETE,
                value="deleteAttribute/{className}/{name}/{sessionId}",
                produces="application/json")
void deleteAttribute​(@NotNull @Valid @PathVariable(value="className",required=true)
                     @NotNull @Valid String className,
                     @NotNull @Valid @PathVariable(value="name",required=true)
                     @NotNull @Valid String name,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

      • deleteAttributeForClassWithId

        @RequestMapping(method=DELETE,
                value="deleteAttributeForClassWithId/{classId}/{name}/{sessionId}",
                produces="application/json")
void deleteAttributeForClassWithId​(@NotNull @Valid @PathVariable(value="classId",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long classId,
                                   @NotNull @Valid @PathVariable(value="name",required=true)
                                   @NotNull @Valid String name,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)

      • getPossibleChildren

        @RequestMapping(method=GET,
                value="getPossibleChildren/{parentClassName}/{ignoreAbstract}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getPossibleChildren​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                             @NotNull @Valid String parentClassName,
                                             @NotNull @Valid @PathVariable(value="ignoreAbstract",required=true)
                                             @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreAbstract,
                                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                             @NotNull @Valid String sessionId)

      • getPossibleSpecialChildren

        @RequestMapping(method=GET,
                value="getPossibleSpecialChildren/{parentClassName}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getPossibleSpecialChildren​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                                    @NotNull @Valid String parentClassName,
                                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                    @NotNull @Valid String sessionId)

      • getPossibleChildrenNoRecursive

        @RequestMapping(method=GET,
                value="getPossibleChildrenNoRecursive/{parentClassName}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getPossibleChildrenNoRecursive​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                                        @NotNull @Valid String parentClassName,
                                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                        @NotNull @Valid String sessionId)

      • getPossibleSpecialChildrenNoRecursive

        @RequestMapping(method=GET,
                value="getPossibleSpecialChildrenNoRecursive/{parentClassName}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getPossibleSpecialChildrenNoRecursive​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                                               @NotNull @Valid String parentClassName,
                                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                               @NotNull @Valid String sessionId)

      • canBeChild

        @RequestMapping(method=GET,
                value="canBeChild/{allegedParent}/{childToBeEvaluated}/{sessionId}",
                produces="application/json")
boolean canBeChild​(@NotNull @Valid @PathVariable(value="allegedParent",required=true)
                   @NotNull @Valid String allegedParent,
                   @NotNull @Valid @PathVariable(value="childToBeEvaluated",required=true)
                   @NotNull @Valid String childToBeEvaluated,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

      • canBeSpecialChild

        @RequestMapping(method=GET,
                value="canBeSpecialChild/{allegedParent}/{childToBeEvaluated}/{sessionId}",
                produces="application/json")
boolean canBeSpecialChild​(@NotNull @Valid @PathVariable(value="allegedParent",required=true)
                          @NotNull @Valid String allegedParent,
                          @NotNull @Valid @PathVariable(value="childToBeEvaluated",required=true)
                          @NotNull @Valid String childToBeEvaluated,
                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                          @NotNull @Valid String sessionId)

      • addPossibleChildrenForClassWithId

        @RequestMapping(method=POST,
                value="addPossibleChildrenForClassWithId/{parentClassId}/{possibleChildren}/{sessionId}",
                produces="application/json")
void addPossibleChildrenForClassWithId​(@NotNull @Valid @PathVariable(value="parentClassId",required=true)
                                       @javax.validation.constraints.NotNull,@javax.validation.Valid long parentClassId,
                                       @NotNull @Valid @PathVariable(value="possibleChildren",required=true)
                                       @javax.validation.constraints.NotNull,@javax.validation.Valid long[] possibleChildren,
                                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                       @NotNull @Valid String sessionId)

      • addPossibleChildren

        @RequestMapping(method=POST,
                value="addPossibleChildren/{parentClassName}/{possibleChildren}/{sessionId}",
                produces="application/json")
void addPossibleChildren​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                         @NotNull @Valid String parentClassName,
                         @NotNull @Valid @PathVariable(value="possibleChildren",required=true)
                         @NotNull @Valid String[] possibleChildren,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

      • addPossibleSpecialChildrenWithId

        @RequestMapping(method=POST,
                value="addPossibleSpecialChildrenWithId/{parentClassId}/{possibleSpecialChildren}/{sessionId}",
                produces="application/json")
void addPossibleSpecialChildrenWithId​(@NotNull @Valid @PathVariable(value="parentClassId",required=true)
                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long parentClassId,
                                      @NotNull @Valid @PathVariable(value="possibleSpecialChildren",required=true)
                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long[] possibleSpecialChildren,
                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                      @NotNull @Valid String sessionId)

      • addPossibleSpecialChildren

        @RequestMapping(method=POST,
                value="addPossibleSpecialChildren/{parentClassName}/{possibleSpecialChildren}/{sessionId}",
                produces="application/json")
void addPossibleSpecialChildren​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                @NotNull @Valid String parentClassName,
                                @NotNull @Valid @PathVariable(value="possibleSpecialChildren",required=true)
                                @NotNull @Valid String[] possibleSpecialChildren,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)

      • removePossibleChildren

        @RequestMapping(method=DELETE,
                value="removePossibleChildren/{parentClassId}/{childrenToBeRemoved}/{sessionId}",
                produces="application/json")
void removePossibleChildren​(@NotNull @Valid @PathVariable(value="parentClassId",required=true)
                            @javax.validation.constraints.NotNull,@javax.validation.Valid long parentClassId,
                            @NotNull @Valid @PathVariable(value="childrenToBeRemoved",required=true)
                            @javax.validation.constraints.NotNull,@javax.validation.Valid long[] childrenToBeRemoved,
                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                            @NotNull @Valid String sessionId)

      • removePossibleSpecialChildren

        @RequestMapping(method=DELETE,
                value="removePossibleSpecialChildren/{parentClassId}/{childrenToBeRemoved}/{sessionId}",
                produces="application/json")
void removePossibleSpecialChildren​(@NotNull @Valid @PathVariable(value="parentClassId",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long parentClassId,
                                   @NotNull @Valid @PathVariable(value="childrenToBeRemoved",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long[] childrenToBeRemoved,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)

      • setSpecialRelationshipDisplayName

        @RequestMapping(method=PUT,
                value="setSpecialRelationshipDisplayName/{relationshipName}/{relationshipDisplayName}/{sessionId}",
                produces="application/json")
void setSpecialRelationshipDisplayName​(@NotNull @Valid @PathVariable(value="relationshipName",required=true)
                                       @NotNull @Valid String relationshipName,
                                       @NotNull @Valid @PathVariable(value="relationshipDisplayName",required=true)
                                       @NotNull @Valid String relationshipDisplayName,
                                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                       @NotNull @Valid String sessionId)

      • getSpecialRelationshipDisplayName

        @RequestMapping(method=GET,
                value="getSpecialRelationshipDisplayName/{relationshipName}/{sessionId}",
                produces="application/json")
String getSpecialRelationshipDisplayName​(@NotNull @Valid @PathVariable(value="relationshipName",required=true)
                                         @NotNull @Valid String relationshipName,
                                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                         @NotNull @Valid String sessionId)

      • getUpstreamContainmentHierarchy

        @RequestMapping(method=GET,
                value="getUpstreamContainmentHierarchy/{className}/{recursive}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getUpstreamContainmentHierarchy​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                         @NotNull @Valid String className,
                                                         @NotNull @Valid @PathVariable(value="recursive",required=true)
                                                         @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive,
                                                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                         @NotNull @Valid String sessionId)

      • getUpstreamSpecialContainmentHierarchy

        @RequestMapping(method=GET,
                value="getUpstreamSpecialContainmentHierarchy/{className}/{recursive}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getUpstreamSpecialContainmentHierarchy​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                                @NotNull @Valid String className,
                                                                @NotNull @Valid @PathVariable(value="recursive",required=true)
                                                                @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive,
                                                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                                @NotNull @Valid String sessionId)

      • getUpstreamClassHierarchy

        @RequestMapping(method=GET,
                value="getUpstreamClassHierarchy/{className}/{includeSelf}/{sessionId}",
                produces="application/json")
List<ClassMetadataLight> getUpstreamClassHierarchy​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                   @NotNull @Valid String className,
                                                   @NotNull @Valid @PathVariable(value="includeSelf",required=true)
                                                   @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeSelf,
                                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                   @NotNull @Valid String sessionId)