Package org.alfresco.governance.classification.handler

Interface ClassificationGuidesApi

All Known Subinterfaces:

ClassificationGuidesApiClient

public interface ClassificationGuidesApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<InstructionEntry>	combinedInstructions(@Valid CombinedInstructionBody instructions)
org.springframework.http.ResponseEntity<ClassificationGuideEntry>	createClassificationGuide(@Valid ClassificationGuideBody classificationGuide)
org.springframework.http.ResponseEntity<TopicEntry>	createSubtopic(String topicId, @Valid TopicBody topic, @Valid List<String> include)
org.springframework.http.ResponseEntity<TopicEntry>	createTopic(String classificationGuideId, @Valid TopicBody topic, @Valid List<String> include)
org.springframework.http.ResponseEntity<Void>	deleteClassificationGuide(String classificationGuideId)
org.springframework.http.ResponseEntity<Void>	deleteTopic(String topicId)
org.springframework.http.ResponseEntity<ClassificationGuidePaging>	listClassificationGuides(@Valid List<String> include, @Min(0L) @Valid Integer skipCount, @Min(1L) @Valid Integer maxItems, @Valid List<String> orderBy, @Valid String where)
org.springframework.http.ResponseEntity<SubtopicPaging>	listSubtopics(String topicId, @Valid List<String> include, @Min(0L) @Valid Integer skipCount, @Min(1L) @Valid Integer maxItems, @Valid List<String> orderBy, @Valid String where, @Valid Boolean includeSource)
org.springframework.http.ResponseEntity<TopicPaging>	listTopics(String classificationGuideId, @Valid List<String> include, @Min(0L) @Valid Integer skipCount, @Min(1L) @Valid Integer maxItems, @Valid List<String> orderBy, @Valid String where, @Valid Boolean includeSource)
org.springframework.http.ResponseEntity<ClassificationGuideEntry>	showClassificationGuideById(String classificationGuideId)
org.springframework.http.ResponseEntity<TopicEntry>	showTopicById(String topicId, @Valid List<String> include)
org.springframework.http.ResponseEntity<ClassificationGuideEntry>	updateClassificationGuide(String classificationGuideId, @Valid ClassificationGuideBody classificationGuide)
org.springframework.http.ResponseEntity<TopicEntry>	updateTopic(String topicId, @Valid TopicBody topic, @Valid List<String> include)

Method Detail

combinedInstructions

@RequestMapping(value="/combined-instructions",
                produces="application/json",
                consumes="application/json",
                method=POST)
org.springframework.http.ResponseEntity<InstructionEntry> combinedInstructions(@Valid @RequestBody
                                                                               @Valid CombinedInstructionBody instructions)

createClassificationGuide

@RequestMapping(value="/classification-guides",
                produces="application/json",
                consumes="application/json",
                method=POST)
org.springframework.http.ResponseEntity<ClassificationGuideEntry> createClassificationGuide(@Valid @RequestBody
                                                                                            @Valid ClassificationGuideBody classificationGuide)

createSubtopic

@RequestMapping(value="/topics/{topicId}/subtopics",
                produces="application/json",
                consumes="application/json",
                method=POST)
org.springframework.http.ResponseEntity<TopicEntry> createSubtopic(@PathVariable("topicId")
                                                                   String topicId,
                                                                   @Valid @RequestBody
                                                                   @Valid TopicBody topic,
                                                                   @Valid @RequestParam(value="include",required=false)
                                                                   @Valid List<String> include)

createTopic

@RequestMapping(value="/classification-guides/{classificationGuideId}/topics",
                produces="application/json",
                consumes="application/json",
                method=POST)
org.springframework.http.ResponseEntity<TopicEntry> createTopic(@PathVariable("classificationGuideId")
                                                                String classificationGuideId,
                                                                @Valid @RequestBody
                                                                @Valid TopicBody topic,
                                                                @Valid @RequestParam(value="include",required=false)
                                                                @Valid List<String> include)

deleteClassificationGuide

@RequestMapping(value="/classification-guides/{classificationGuideId}",
                produces="application/json",
                consumes="",
                method=DELETE)
org.springframework.http.ResponseEntity<Void> deleteClassificationGuide(@PathVariable("classificationGuideId")
                                                                        String classificationGuideId)

deleteTopic

@RequestMapping(value="/topics/{topicId}",
                produces="application/json",
                consumes="",
                method=DELETE)
org.springframework.http.ResponseEntity<Void> deleteTopic(@PathVariable("topicId")
                                                          String topicId)

listClassificationGuides

@RequestMapping(value="/classification-guides",
                produces="application/json",
                consumes="",
                method=GET)
org.springframework.http.ResponseEntity<ClassificationGuidePaging> listClassificationGuides(@Valid @RequestParam(value="include",required=false)
                                                                                            @Valid List<String> include,
                                                                                            @Min(0L) @Valid @RequestParam(value="skipCount",required=false)
                                                                                            @Min(0L) @Valid Integer skipCount,
                                                                                            @Min(1L) @Valid @RequestParam(value="maxItems",required=false)
                                                                                            @Min(1L) @Valid Integer maxItems,
                                                                                            @Valid @RequestParam(value="orderBy",required=false)
                                                                                            @Valid List<String> orderBy,
                                                                                            @Valid @RequestParam(value="where",required=false)
                                                                                            @Valid String where)

listSubtopics

@RequestMapping(value="/topics/{topicId}/subtopics",
                produces="application/json",
                consumes="",
                method=GET)
org.springframework.http.ResponseEntity<SubtopicPaging> listSubtopics(@PathVariable("topicId")
                                                                      String topicId,
                                                                      @Valid @RequestParam(value="include",required=false)
                                                                      @Valid List<String> include,
                                                                      @Min(0L) @Valid @RequestParam(value="skipCount",required=false)
                                                                      @Min(0L) @Valid Integer skipCount,
                                                                      @Min(1L) @Valid @RequestParam(value="maxItems",required=false)
                                                                      @Min(1L) @Valid Integer maxItems,
                                                                      @Valid @RequestParam(value="orderBy",required=false)
                                                                      @Valid List<String> orderBy,
                                                                      @Valid @RequestParam(value="where",required=false)
                                                                      @Valid String where,
                                                                      @Valid @RequestParam(value="includeSource",required=false)
                                                                      @Valid Boolean includeSource)

listTopics

@RequestMapping(value="/classification-guides/{classificationGuideId}/topics",
                produces="application/json",
                consumes="",
                method=GET)
org.springframework.http.ResponseEntity<TopicPaging> listTopics(@PathVariable("classificationGuideId")
                                                                String classificationGuideId,
                                                                @Valid @RequestParam(value="include",required=false)
                                                                @Valid List<String> include,
                                                                @Min(0L) @Valid @RequestParam(value="skipCount",required=false)
                                                                @Min(0L) @Valid Integer skipCount,
                                                                @Min(1L) @Valid @RequestParam(value="maxItems",required=false)
                                                                @Min(1L) @Valid Integer maxItems,
                                                                @Valid @RequestParam(value="orderBy",required=false)
                                                                @Valid List<String> orderBy,
                                                                @Valid @RequestParam(value="where",required=false)
                                                                @Valid String where,
                                                                @Valid @RequestParam(value="includeSource",required=false)
                                                                @Valid Boolean includeSource)

showClassificationGuideById

@RequestMapping(value="/classification-guides/{classificationGuideId}",
                produces="application/json",
                consumes="",
                method=GET)
org.springframework.http.ResponseEntity<ClassificationGuideEntry> showClassificationGuideById(@PathVariable("classificationGuideId")
                                                                                              String classificationGuideId)

showTopicById

@RequestMapping(value="/topics/{topicId}",
                produces="application/json",
                consumes="",
                method=GET)
org.springframework.http.ResponseEntity<TopicEntry> showTopicById(@PathVariable("topicId")
                                                                  String topicId,
                                                                  @Valid @RequestParam(value="include",required=false)
                                                                  @Valid List<String> include)

updateClassificationGuide

@RequestMapping(value="/classification-guides/{classificationGuideId}",
                produces="application/json",
                consumes="application/json",
                method=PUT)
org.springframework.http.ResponseEntity<ClassificationGuideEntry> updateClassificationGuide(@PathVariable("classificationGuideId")
                                                                                            String classificationGuideId,
                                                                                            @Valid @RequestBody
                                                                                            @Valid ClassificationGuideBody classificationGuide)

updateTopic

@RequestMapping(value="/topics/{topicId}",
                produces="application/json",
                consumes="application/json",
                method=PUT)
org.springframework.http.ResponseEntity<TopicEntry> updateTopic(@PathVariable("topicId")
                                                                String topicId,
                                                                @Valid @RequestBody
                                                                @Valid TopicBody topic,
                                                                @Valid @RequestParam(value="include",required=false)
                                                                @Valid List<String> include)