#4410 - Comments on classes

Joaquín Reñé

2025-10-07 146a0fb8b0e90f9196e569152f649baf60d6cc8f

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
* Copyright @ 2013 CurisTEC, S.A.S. All Rights Reserved.
*/
package net.curisit.securis.db.common;

/**
* Metadata
* <p>
* Contract for metadata entries (key/value/mandatory).
* Implemented by ApplicationMetadata, LicenseTypeMetadata, PackMetadata, etc.
* 
* @author JRA
* Last reviewed by JRA on Oct 5, 2025.
*/
public interface Metadata {
    
    /** 
     * getKey<p>
     * Return entry key.
     * 
     * @return key
     */
    String getKey();
    
    /** 
     * setKey<p>
     * Set entry key. 
     * 
     * @param key
     */
    void setKey(String key);

    /** 
     * getValue<p>
     * Return entry value. 
     * 
     * @return value
     */
    String getValue();
    
    /** 
     * setValue<p>
     * Set entry value. 
     * 
     * @param value
     */
    void setValue(String value);

    /** 
     * isMandatory<p>
     * Whether this metadata is required. 
     * 
     * @return isMandatory
     */
    boolean isMandatory();
    
    /** 
     * setMandatory<p>
     * Set required flag. 
     * 
     * @param mandatory
     */
    void setMandatory(boolean mandatory);
}