Accessing All Data Categories Associated with an sObject

1public with sharing class DescribeDataCategoryGroupSample {
2    public static List<DescribeDataCategoryGroupResult> describeDataCategoryGroupSample(){
3        List<DescribeDataCategoryGroupResult> describeCategoryResult;
4        try {
5            //Creating the list of sobjects to use for the describe
6            //call
7            List<String> objType = new List<String>();
8
9            objType.add('KnowledgeArticleVersion');
10            objType.add('Question');
11
12            //Describe Call
13            describeCategoryResult = Schema.describeDataCategoryGroups(objType);
14
15            //Using the results and retrieving the information
16            for(DescribeDataCategoryGroupResult singleResult : describeCategoryResult){
17                //Getting the name of the category
18                singleResult.getName();
19
20                //Getting the name of label
21                singleResult.getLabel();
22
23                //Getting description
24                singleResult.getDescription();
25
26                //Getting the sobject
27                singleResult.getSobject();
28            }
29        } catch(Exception e){
30        }
31
32        return describeCategoryResult;
33    }
34}

1public with sharing class DescribeDataCategoryGroupStructures {
2    public static List<DescribeDataCategoryGroupStructureResult>
3    getDescribeDataCategoryGroupStructureResults(){
4        List<DescribeDataCategoryGroupResult> describeCategoryResult;
5        List<DescribeDataCategoryGroupStructureResult> describeCategoryStructureResult;
6        try {
7            //Making the call to the describeDataCategoryGroups to
8            //get the list of category groups associated
9            List<String> objType = new List<String>();
10            objType.add('KnowledgeArticleVersion');
11            objType.add('Question');
12            describeCategoryResult = Schema.describeDataCategoryGroups(objType);
13
14            //Creating a list of pair objects to use as a parameter
15            //for the describe call
16            List<DataCategoryGroupSobjectTypePair> pairs =
17                new List<DataCategoryGroupSobjectTypePair>();
18
19            //Looping throught the first describe result to create
20            //the list of pairs for the second describe call
21            for(DescribeDataCategoryGroupResult singleResult :
22                describeCategoryResult){
23                DataCategoryGroupSobjectTypePair p =
24                    new DataCategoryGroupSobjectTypePair();
25                p.setSobject(singleResult.getSobject());
26                p.setDataCategoryGroupName(singleResult.getName());
27                pairs.add(p);
28            }
29
30            //describeDataCategoryGroupStructures()
31            describeCategoryStructureResult =
32                Schema.describeDataCategoryGroupStructures(pairs, false);
33
34            //Getting data from the result
35            for(DescribeDataCategoryGroupStructureResult singleResult : describeCategoryStructureResult){
36                //Get name of the associated Sobject
37                singleResult.getSobject();
38
39                //Get the name of the data category group
40                singleResult.getName();
41
42                //Get the name of the data category group
43                singleResult.getLabel();
44
45                //Get the description of the data category group
46                singleResult.getDescription();
47
48                //Get the top level categories
49                DataCategory [] toplevelCategories =
50                    singleResult.getTopCategories();
51
52                //Recursively get all the categories
53                List<DataCategory> allCategories =
54                    getAllCategories(toplevelCategories);
55
56                for(DataCategory category : allCategories) {
57                    //Get the name of the category
58                    category.getName();
59
60                    //Get the label of the category
61                    category.getLabel();
62
63                    //Get the list of sub categories in the category
64                    DataCategory [] childCategories =
65                        category.getChildCategories();
66                }
67            }
68        } catch (Exception e){
69        }
70        return describeCategoryStructureResult;
71    }
72
73    private static DataCategory[] getAllCategories(DataCategory [] categories){
74        if(categories.isEmpty()){
75            return new DataCategory[]{};
76        } else {
77            DataCategory [] categoriesClone = categories.clone();
78            DataCategory category = categoriesClone[0];
79            DataCategory[] allCategories = new DataCategory[]{category};
80            categoriesClone.remove(0);
81            categoriesClone.addAll(category.getChildCategories());
82            allCategories.addAll(getAllCategories(categoriesClone));
83            return allCategories;
84        }
85    }
86}

1@IsTest
2private with sharing class DescribeDataCategoryGroupSampleTest {
3    @IsTest
4    public static void describeDataCategoryGroupSampleTest(){
5        List<DescribeDataCategoryGroupResult> describeResult =
6            DescribeDataCategoryGroupSample.describeDataCategoryGroupSample();
7
8        //Assuming that you have KnowledgeArticleVersion and Questions
9        //associated with only one category group 'Regions'.
10        Assert.areEqual(2, describeResult.size(),
11            'The results should only contain two results: ' + describeResult.size());
12
13        for(DescribeDataCategoryGroupResult result : describeResult) {
14            //Storing the results
15            String name = result.getName();
16            String label = result.getLabel();
17            String description = result.getDescription();
18            String objectNames = result.getSobject();
19
20            //asserting the values to make sure
21            Assert.areEqual('Regions', name,
22                'Incorrect name was returned: ' + name);
23            Assert.areEqual('Regions of the World', label,
24                'Incorrect label was returned: ' + label);
25            Assert.areEqual('This is the category group for all the regions', description,
26                'Incorrect description was returned: ' + description);
27            Assert.isTrue(objectNames.contains('KnowledgeArticleVersion')
28                || objectNames.contains('Question'),
29                'Incorrect sObject was returned: ' + objectNames);
30        }
31    }
32}

1@IsTest
2private with sharing class DescribeDataCategoryGroupStructuresTest {
3    @IsTest
4    public static void getDescribeDataCategoryGroupStructureResultsTest(){
5        List<Schema.DescribeDataCategoryGroupStructureResult> describeResult =
6            DescribeDataCategoryGroupStructures.getDescribeDataCategoryGroupStructureResults();
7
8        Assert.areEqual(2, describeResult.size(),
9            'The results should only contain 2 results: ' + describeResult.size());
10
11        //Creating category info
12        CategoryInfo world = new CategoryInfo('World', 'World');
13        CategoryInfo asia = new CategoryInfo('Asia', 'Asia');
14        CategoryInfo northAmerica = new CategoryInfo('NorthAmerica',
15            'North America');
16        CategoryInfo southAmerica = new CategoryInfo('SouthAmerica',
17            'South America');
18        CategoryInfo europe = new CategoryInfo('Europe', 'Europe');
19
20        List<CategoryInfo> info = new CategoryInfo[] {
21            asia, northAmerica, southAmerica, europe
22        };
23
24        for (Schema.DescribeDataCategoryGroupStructureResult result : describeResult) {
25            String name = result.getName();
26            String label = result.getLabel();
27            String description = result.getDescription();
28            String objectNames = result.getSobject();
29
30            //asserting the values to make sure
31            Assert.areEqual('Regions', name,
32                'Incorrect name was returned: ' + name);
33            Assert.areEqual('Regions of the World', label,
34                'Incorrect label was returned: ' + label);
35            Assert.areEqual('This is the category group for all the regions', description,
36                'Incorrect description was returned: ' + description);
37            Assert.isTrue(objectNames.contains('KnowledgeArticleVersion')
38                || objectNames.contains('Question'),
39                'Incorrect sObject was returned: ' + objectNames);
40
41            DataCategory [] topLevelCategories = result.getTopCategories();
42            Assert.areEqual(1, topLevelCategories.size(),
43                'Incorrect number of top level categories returned: ' + topLevelCategories.size());
44            Assert.areEqual(world.getLabel(), topLevelCategories[0].getLabel());
45            Assert.areEqual(world.getName(), topLevelCategories[0].getName());
46
47            //checking if the correct children are returned
48            DataCategory [] children = topLevelCategories[0].getChildCategories();
49            Assert.areEqual(4, children.size(),
50                'Incorrect number of children returned: ' + children.size());
51            for (Integer i=0; i < children.size(); i++) {
52                Assert.areEqual(info[i].getLabel(), children[i].getLabel());
53                Assert.areEqual(info[i].getName(), children[i].getName());
54            }
55        }
56    }
57
58    private with sharing class CategoryInfo {
59        private final String name;
60        private final String label;
61
62        private CategoryInfo(String n, String l){
63            this.name = n;
64            this.label = l;
65        }
66
67        public String getName(){
68            return this.name;
69        }
70
71        public String getLabel(){
72            return this.label;
73        }
74    }
75}