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

###############################################################################
#
# ObjectGet
# Retrieves one or more objects from Cloudmine.
#
# 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 ObjectGet(Choreography):

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


    def new_input_set(self):
        return ObjectGetInputSet()

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

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

class ObjectGetInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the ObjectGet
    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 CloudMine after registering your app.)
        """
        super(ObjectGetInputSet, self)._set_input('APIKey', value)
    def set_ApplicationIdentifier(self, value):
        """
        Set the value of the ApplicationIdentifier input for this Choreo. ((required, string) The application identifier provided by CloudMine after registering your app.)
        """
        super(ObjectGetInputSet, self)._set_input('ApplicationIdentifier', value)
    def set_Count(self, value):
        """
        Set the value of the Count input for this Choreo. ((optional, boolean) Returns a count of the results in the response if set to true. Valid values are true and false.)
        """
        super(ObjectGetInputSet, self)._set_input('Count', value)
    def set_Keys(self, value):
        """
        Set the value of the Keys input for this Choreo. ((optional, string) A comma separated list of keys to return. If not specified, all key/value pairs are returned.)
        """
        super(ObjectGetInputSet, self)._set_input('Keys', value)
    def set_Limit(self, value):
        """
        Set the value of the Limit input for this Choreo. ((optional, integer) Limits the number of results returned. Use -1 for no limit. Use 0 for no results, and with Count=true to just get the number of available results. This defaults to 50.)
        """
        super(ObjectGetInputSet, self)._set_input('Limit', value)
    def set_SessionToken(self, value):
        """
        Set the value of the SessionToken input for this Choreo. ((conditional, string) The session token for an existing user (returned by the AccountLogin Choreo). This is only required if your app is performing this operation on behalf of another user.)
        """
        super(ObjectGetInputSet, self)._set_input('SessionToken', value)
    def set_Skip(self, value):
        """
        Set the value of the Skip input for this Choreo. ((optional, integer) Indicates to start results after skiping this number objects. Used to page through results.)
        """
        super(ObjectGetInputSet, self)._set_input('Skip', value)

class ObjectGetResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the ObjectGet 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 CloudMine.)
        """
        return self._output.get('Response', None)

class ObjectGetChoreographyExecution(ChoreographyExecution):

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