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

###############################################################################
#
# SearchByCallLetters
# Retrieves local NPR member stations based on uniquely identifying call letters.
#
# 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 SearchByCallLetters(Choreography):

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


    def new_input_set(self):
        return SearchByCallLettersInputSet()

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

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

class SearchByCallLettersInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the SearchByCallLetters
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_APIKey(self, value):
        """
        Set the value of the APIKey input for this Choreo. ((required, string) The API Key provided by NPR.)
        """
        super(SearchByCallLettersInputSet, self)._set_input('APIKey', value)
    def set_Band(self, value):
        """
        Set the value of the Band input for this Choreo. ((optional, string) Enter AM or FM.)
        """
        super(SearchByCallLettersInputSet, self)._set_input('Band', value)
    def set_CallLetters(self, value):
        """
        Set the value of the CallLetters input for this Choreo. ((required, string) Enter the unique identifier associated with a station.)
        """
        super(SearchByCallLettersInputSet, self)._set_input('CallLetters', value)
    def set_ResponseFormat(self, value):
        """
        Set the value of the ResponseFormat input for this Choreo. ((optional, string) The format that the response should be in. Valid values are xml (the default), and json.)
        """
        super(SearchByCallLettersInputSet, self)._set_input('ResponseFormat', value)

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

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

    def get_Response(self):
        """
        Retrieve the value for the "Response" output from this Choreo execution. (The response from NPR.)
        """
        return self._output.get('Response', None)

class SearchByCallLettersChoreographyExecution(ChoreographyExecution):

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