1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 
25 package share;
26 
27 /**
28  *
29  * Structure to describe the entries to be tested
30  *
31  */
32 public class DescEntry {
33 
34     /**
35      * Contains the name used inside the framework
36      */
37     public String entryName;
38     /**
39      * Contains the name that may be used by state writers
40      */
41     public String longName;
42     /**
43      * Contains information if this entry is Optional
44      */
45     public boolean isOptional;
46     /**
47      * Contains information if this entry should be tested
48      */
49     public boolean isToTest;
50     /**
51      * Contains the information about the number of SubEntries
52      */
53     public int SubEntryCount;
54     /**
55      * Contains the SubEntries
56      */
57     public DescEntry[] SubEntries;
58 
59     /**
60      * Contains information about the Type of the entry<br>
61      * possible 'component', 'interface', 'service', 'method', 'property', 'unit'
62      */
63     public String EntryType;
64 
65     /**
66      * Contains the ErrorMsg is something went wrong while gaining<br>
67      * the description
68      */
69     public String ErrorMsg;
70 
71     /**
72      * Contains information if errors occurred while gaining the Description
73      */
74     public boolean hasErrorMsg;
75 
76     /**
77      * Contains the state for this entry
78      */
79     public String State = "UNKNOWN";
80 
81     /**
82      * Contains the LogWriter to be used by the entry-test
83      */
84 
85     public share.LogWriter Logger;
86 
87     /**
88      * Contains an arbitrary set of parameters
89      */
90 
91     public java.util.Hashtable UserDefinedParams = new java.util.Hashtable();
92 
93 }
94