Merge remote-tracking branch 'origin/extended-easysetup'
[platform/upstream/iotivity.git] / service / easy-setup / mediator / richsdk / android / EasySetupCore / src / main / java / org / iotivity / service / easysetup / mediator / CloudPropProvisioningStatus.java
1 /**
2  * ***************************************************************
3  *
4  * Copyright 2016 Samsung Electronics All Rights Reserved.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  * ****************************************************************
19  */
20
21 package org.iotivity.service.easysetup.mediator;
22
23 import org.iotivity.service.easysetup.mediator.enums.ESCloudProvState;
24 import org.iotivity.service.easysetup.mediator.enums.ESResult;
25
26 /**
27  * This interface facilitates Application to get progress & result of Cloud provisioning
28  * process in easy setup
29  */
30 public class CloudPropProvisioningStatus
31 {
32     private ESResult m_result;
33     private ESCloudProvState m_esCloudState;
34
35     /**
36      * Constructor
37      *
38      * @param result a result of cloud property provisioning
39      * @param state a state of cloud property provisioning.
40      *              ES_CLOUD_PROVISIONING_ERROR(-1), ES_CLOUD_PROVISIONING_SUCCESS(0),
41      *              ES_CLOUD_ENROLLEE_FOUND(1), ES_CLOUD_ENROLLEE_NOT_FOUND(2)
42      *
43      * @see ESCloudProvState
44      */
45     public CloudPropProvisioningStatus(int result, int state)
46     {
47         m_result = ESResult.fromInt(result);
48         m_esCloudState = ESCloudProvState.fromInt(state);
49     }
50
51     /**
52      * Get a result of cloud property provisioning
53      *
54      * @result ESResult a result of cloud property provisioning
55      */
56     public ESResult getESResult()
57     {
58         return m_result;
59     }
60
61     /**
62      * Get a state of cloud property provisioning
63      *
64      * @result ESCloudProvState a state of cloud property provisioning
65      *
66      * @see ESCloudProvState
67      */
68     public ESCloudProvState getESCloudState()
69     {
70         return m_esCloudState;
71     }
72 };