# -*- coding: utf-8 -*-

###############################################################################
#
# SetValid
# Sets a specified token as valid or invalid.
#
# Python versions 2.6, 2.7, 3.x
#
# Copyright 2014, Temboo Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
# either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
#
#
###############################################################################

from temboo.core.choreography import Choreography
from temboo.core.choreography import InputSet
from temboo.core.choreography import ResultSet
from temboo.core.choreography import ChoreographyExecution

import json

class SetValid(Choreography):

    def __init__(self, temboo_session):
        """
        Create a new instance of the SetValid Choreo. A TembooSession object, containing a valid
        set of Temboo credentials, must be supplied.
        """
        super(SetValid, self).__init__(temboo_session, '/Library/Utilities/TokenStorage/SetValid')


    def new_input_set(self):
        return SetValidInputSet()

    def _make_result_set(self, result, path):
        return SetValidResultSet(result, path)

    def _make_execution(self, session, exec_id, path):
        return SetValidChoreographyExecution(session, exec_id, path)

class SetValidInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the SetValid
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_Name(self, value):
        """
        Set the value of the Name input for this Choreo. ((required, string) The name of the token to modify.)
        """
        super(SetValidInputSet, self)._set_input('Name', value)
    def set_Valid(self, value):
        """
        Set the value of the Valid input for this Choreo. ((conditional, boolean) Can be set to true or false depending on whether the token is valid or not.)
        """
        super(SetValidInputSet, self)._set_input('Valid', value)

class SetValidResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the SetValid Choreo.
    The ResultSet object is used to retrieve the results of a Choreo execution.
    """

    def getJSONFromString(self, str):
        return json.loads(str)

    def get_Updated(self):
        """
        Retrieve the value for the "Updated" output from this Choreo execution. ((boolean) Returns true if the operation was successful.)
        """
        return self._output.get('Updated', None)

class SetValidChoreographyExecution(ChoreographyExecution):

    def _make_result_set(self, response, path):
        return SetValidResultSet(response, path)
