aboutsummaryrefslogtreecommitdiffstats
path: root/services/about/cpp/inc/alljoyn/about/PropertyStore.h
blob: 12aabfb9ed4db5c4d8fafab2201e792c9ef73d6d (plain)
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/**
 * @file
 * User implemented property store responsible for holding the AboutService properties
 * @see AboutPropertyStoreImpl.h
 */
/******************************************************************************
 *    Copyright (c) Open Connectivity Foundation (OCF), AllJoyn Open Source
 *    Project (AJOSP) Contributors and others.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    All rights reserved. This program and the accompanying materials are
 *    made available under the terms of the Apache License, Version 2.0
 *    which accompanies this distribution, and is available at
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Copyright (c) Open Connectivity Foundation and Contributors to AllSeen
 *    Alliance. All rights reserved.
 *
 *    Permission to use, copy, modify, and/or distribute this software for
 *    any purpose with or without fee is hereby granted, provided that the
 *    above copyright notice and this permission notice appear in all
 *    copies.
 *
 *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 *    WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 *    WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 *    AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 *    DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 *    PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 *    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 *    PERFORMANCE OF THIS SOFTWARE.
 ******************************************************************************/
#ifndef _PROPERTYSTORE_H
#define _PROPERTYSTORE_H

#include <alljoyn/Status.h>
#include <alljoyn/MsgArg.h>

namespace ajn {
namespace services {
/**
 * The language tag specified is not supported
 */
#define ER_LANGUAGE_NOT_SUPPORTED       ((QStatus)0xb001)
/**
 * The request feature is not available or has not be implemented
 */
#define ER_FEATURE_NOT_AVAILABLE        ((QStatus)0xb002)
/**
 * The value requested is invalid
 */
#define ER_INVALID_VALUE                ((QStatus)0xb003)
/**
 * The maximum allowed size for an element has been exceeded.
 */
#define ER_MAX_SIZE_EXCEEDED            ((QStatus)0xb004)

/**
 * PropertyStore is implemented by the application , it is responsible to store
 * the properties of the AboutServie and ConfigService.
 *
 * @deprecated The PropertyStore class has been deprecated please see the
 * AboutDataListener class for similar functionality as the PropertyStore class.
 */
class PropertyStore {
  public:

    /**
     * Filter has three possible values ANNOUNCE, READ,WRITE
     * READ is for data that is marked as read
     * ANNOUNCE is for data that is marked as announce
     * WRITE is for data that is marked as write
     */
    typedef enum {
        ANNOUNCE,         //!< ANNOUNCE Property that has  ANNOUNCE  enabled
        READ,            //!< READ     Property that has READ  enabled
        WRITE,           //!< WRITE    Property that has  WRITE  enabled
    } Filter;

    /**
     * Calls Reset() implemented only for  ConfigService
     *
     * @deprecated The PropertyStore::Reset function has been deprecated please
     * see the AboutDataListener class. There is not equivalent functionality
     * for the Reset function in the AboutDataListener or the AboutData class.
     * If this functionality is required the developer is responsible for adding
     * it by creating there own AboutdataListener implementation.
     *
     * @return status
     */
    QCC_DEPRECATED(virtual QStatus Reset()) {
        return ER_NOT_IMPLEMENTED;
    }

    /**
     * @deprecated The PropertyStore::Reset function has been deprecated please
     * see the AboutDataListener::GetAboutData function and
     * AboutDataListener::GetAnnouncedAboutData function.
     *
     * @param[in] languageTag is the language to use for the action can be NULL meaning default.
     * @param[in] filter describe which properties to read.
     * @param[out] all reference to MsgArg
     * @return status
     */
    QCC_DEPRECATED(virtual QStatus ReadAll(const char* languageTag, Filter filter, ajn::MsgArg & all)) = 0;

    /**
     * @deprecated The PropertyStore::Update function has been deprecated please
     * see the AboutDataListener class. There is not equivalent functionality
     * for the Update function in the AboutDataListener or the AboutData class.
     * If this functionality is required the developer is responsible for adding
     * it by creating there own AboutdataListener implementation.
     *
     * @param[in] name of the property
     * @param[in] languageTag is the language to use for the action can be NULL meaning default.
     * @param[in] value is a pointer to the data to change.
     * @return status
     */
    QCC_DEPRECATED(virtual QStatus Update(const char* name, const char* languageTag, const ajn::MsgArg * value)) {
        QCC_UNUSED(name);
        QCC_UNUSED(languageTag);
        QCC_UNUSED(value);
        return ER_NOT_IMPLEMENTED;
    }
    /**
     * @deprecated The PropertyStore::Update function has been deprecated please
     * see the AboutDataListener class. There is not equivalent functionality
     * for the Update function in the AboutDataListener or the AboutData class.
     * If this functionality is required the developer is responsible for adding
     * it by creating there own AboutdataListener implementation.
     *
     * @param[in] name of the property
     * @param[in] languageTag is the language to use for the action can't be NULL.
     * @return[in] status
     */
    QCC_DEPRECATED(virtual QStatus Delete(const char* name, const char* languageTag)) {
        QCC_UNUSED(name);
        QCC_UNUSED(languageTag);
        return ER_NOT_IMPLEMENTED;
    }
    /**
     * Desctructor of PropertyStore
     *
     * @deprecated The PropertyStore class has been deprecated please see the
     * AboutDataListener class.
     */
    QCC_DEPRECATED(virtual ~PropertyStore()) = 0;
};
inline PropertyStore::~PropertyStore() {
}

}
}

#endif /* _PROPERTYSTORE_H */