1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 
29 package share;
30 
31 /**
32  *
33  * Structure to describe the entries to be tested
34  *
35  */
36 public class DescEntry {
37 
38     /**
39      * Contains the name used inside the framework
40      */
41     public String entryName;
42     /**
43      * Contains the name that may be used by state writers
44      */
45     public String longName;
46     /**
47      * Contains information if this entry is Optional
48      */
49     public boolean isOptional;
50     /**
51      * Contains information if this entry should be tested
52      */
53     public boolean isToTest;
54     /**
55      * Contains the information about the number of SubEntries
56      */
57     public int SubEntryCount;
58     /**
59      * Contains the SubEntries
60      */
61     public DescEntry[] SubEntries;
62 
63     /**
64      * Contains information about the Type of the entry<br>
65      * possible 'component', 'interface', 'service', 'method', 'property', 'unit'
66      */
67     public String EntryType;
68 
69     /**
70      * Contains the ErrorMsg is something went wrong while gaining<br>
71      * the description
72      */
73     public String ErrorMsg;
74 
75     /**
76      * Contains information if errors occured while gaining the Description
77      */
78     public boolean hasErrorMsg;
79 
80     /**
81      * Contains the state for this entry
82      */
83     public String State = "UNKNOWN";
84 
85     /**
86      * Contains the LogWriter to be used by the entry-test
87      */
88 
89     public share.LogWriter Logger;
90 
91     /**
92      * Contains an arbitrary set of parameters
93      */
94 
95     public java.util.Hashtable UserDefinedParams = new java.util.Hashtable();
96 
97 }
98