com.kallasoft.smugmug.api.json.v1_2_1.users
Class GetTransferStats

java.lang.Object
  com.kallasoft.smugmug.api.json.AbstractMethod
      com.kallasoft.smugmug.api.json.v1_2_0.users.GetTransferStats
          com.kallasoft.smugmug.api.json.v1_2_1.users.GetTransferStats

All Implemented Interfaces:

Method

public class GetTransferStats
extends GetTransferStats

This class is a convenience class extending the base GetTransferStats implementation.

Version:

1.2.1

Author:

Riyad Kalla

See Also:

GetTransferStats

Nested Class Summary

class

GetTransferStats.GetTransferStatsResponse This class is a convenience class extending the base GetTransferStats.GetTransferStatsResponse implementation.

Field Summary

Fields inherited from class com.kallasoft.smugmug.api.json.v1_2_0.users.GetTransferStats

ARGUMENTS, METHOD_NAME

Constructor Summary

GetTransferStats()
Construct a new method instance that can be executed.

GetTransferStats(String methodName, String[] arguments)
Construct a new method instance that can be executed with the given arguments.

Method Summary

GetTransferStats.GetTransferStatsResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.users.getTransferStats method, returning a response containing the transfer statistics requested for the particular user (assuming SmugMug had them on file).
GetTransferStats.GetTransferStatsResponse	execute(String url, String apiKey, String sessionID, Integer month, Integer year, Boolean heavy) Convenience method used to execute the smugmug.users.getTransferStats method.

Methods inherited from class com.kallasoft.smugmug.api.json.AbstractMethod

executeImpl, getArguments, getMethodName, setupPostParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetTransferStats

public GetTransferStats()

Construct a new method instance that can be executed.

GetTransferStats

public GetTransferStats(String methodName,
                        String[] arguments)

Construct a new method instance that can be executed with the given arguments.

Parameters:

methodName - The name of the SmugMug JSON API method that this Method represents.

arguments - The names of the arguments that this method accepts.

Method Detail

execute

public GetTransferStats.GetTransferStatsResponse execute(String url,
                                                         String[] argumentValues)

Description copied from class: GetTransferStats

Used to execute the smugmug.users.getTransferStats method, returning a response containing the transfer statistics requested for the particular user (assuming SmugMug had them on file).

Specified by:

execute in interface Method

Overrides:

execute in class GetTransferStats

Parameters:

url - The URL of the SmugMug server to communicate with.

argumentValues - The argument values to pass to this method.

Returns:

the response that includes all the transfer statistics for the user requested (assuming SmugMug had them on file).

execute

public GetTransferStats.GetTransferStatsResponse execute(String url,
                                                         String apiKey,
                                                         String sessionID,
                                                         Integer month,
                                                         Integer year,
                                                         Boolean heavy)

Description copied from class: GetTransferStats

Convenience method used to execute the smugmug.users.getTransferStats method.

This method performs necessary conversions on all the argument values before calling GetTransferStats.execute(String, String[]).

Overrides:

execute in class GetTransferStats

Parameters:

url - The URL of the SmugMug server to communicate with.

apiKey - The API Key to use. API keys are issued by SmugMug.

sessionID - The logged in SessionID that represents the user's session.

month - A number (1-12) indicating a month to get transfer statistics for.

year - A number (e.g. 2007) indicating the year to get the transfer statistics for.

heavy - Set to true to return heavy results, including transfer stats for all the images in the album as well, otherwise set to false.

Returns:

the response that includes all the transfer statistics for the given user for the given span of time (assuming SmugMug had it on file).

See Also:

GetTransferStats.execute(String, String[])