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

###############################################################################
#
# Search
# Searches for files and folders.
#
# 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 Search(Choreography):

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


    def new_input_set(self):
        return SearchInputSet()

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

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

class SearchInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the Search
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_AccessToken(self, value):
        """
        Set the value of the AccessToken input for this Choreo. ((required, string) The access token for a specific Dropbox user.)
        """
        super(SearchInputSet, self)._set_input('AccessToken', value)
    def set_MaxResults(self, value):
        """
        Set the value of the MaxResults input for this Choreo. ((optional, boolean) The maximum number of search results to return. The default for this field is 100.)
        """
        super(SearchInputSet, self)._set_input('MaxResults', value)
    def set_Mode(self, value):
        """
        Set the value of the Mode input for this Choreo. ((optional, string) The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.)
        """
        super(SearchInputSet, self)._set_input('Mode', value)
    def set_Path(self, value):
        """
        Set the value of the Path input for this Choreo. ((conditional, string) Path in the user's Dropbox to search. This should be empty to search at the root level.)
        """
        super(SearchInputSet, self)._set_input('Path', value)
    def set_Query(self, value):
        """
        Set the value of the Query input for this Choreo. ((optional, boolean) The string to search for. )
        """
        super(SearchInputSet, self)._set_input('Query', value)
    def set_Start(self, value):
        """
        Set the value of the Start input for this Choreo. ((optional, integer) The starting index within the search results (used for paging). The default for this field is 0.)
        """
        super(SearchInputSet, self)._set_input('Start', value)

class SearchResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the Search 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. ((json) The response from Dropbox.)
        """
        return self._output.get('Response', None)

class SearchChoreographyExecution(ChoreographyExecution):

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