com.kallasoft.smugmug.api.json.v1_2_1.albums
Class GetStats

java.lang.Object
  com.kallasoft.smugmug.api.json.AbstractMethod
      com.kallasoft.smugmug.api.json.v1_2_0.albums.GetStats
          com.kallasoft.smugmug.api.json.v1_2_1.albums.GetStats

All Implemented Interfaces:

Method

public class GetStats
extends GetStats

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

Version:

1.2.1

Author:

Riyad Kalla

See Also:

GetStats

Nested Class Summary

class

GetStats.GetStatsResponse This class is a convenience class extending the base GetStats.GetStatsResponse implementation.

Field Summary

Fields inherited from class com.kallasoft.smugmug.api.json.v1_2_0.albums.GetStats

ARGUMENTS, METHOD_NAME

Constructor Summary

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

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

Method Summary

GetStats.GetStatsResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.albums.getStats method, returning the transfer stats for an album, and if the response is heavy, returning transfer stats for all the images in the album as well.
GetStats.GetStatsResponse	execute(String url, String apiKey, String sessionID, Integer albumID, Integer month, Integer year) Convenience method used to execute the smugmug.albums.getStats method.
GetStats.GetStatsResponse	execute(String url, String apiKey, String sessionID, Integer albumID, Integer month, Integer year, Boolean heavy) Convenience method used to execute the smugmug.albums.getStats 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

GetStats

public GetStats()

Construct a new method instance that can be executed.

GetStats

public GetStats(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 GetStats.GetStatsResponse execute(String url,
                                         String[] argumentValues)

Description copied from class: GetStats

Used to execute the smugmug.albums.getStats method, returning the transfer stats for an album, and if the response is heavy, returning transfer stats for all the images in the album as well.

Specified by:

execute in interface Method

Overrides:

execute in class GetStats

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 the transfer stats for the given album and if the response is heavy, a list of transfer stats for each image in the album.

execute

public GetStats.GetStatsResponse execute(String url,
                                         String apiKey,
                                         String sessionID,
                                         Integer albumID,
                                         Integer month,
                                         Integer year)

Description copied from class: GetStats

Convenience method used to execute the smugmug.albums.getStats method.

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

Overrides:

execute in class GetStats

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.

albumID - The ID of the album to get the transfer stats for.

month - The number of the month (1-12) to get the transfer stats for the given album.

year - The year (e.g. 2007) to get the transfer stats for the given album.

Returns:

the response that includes the transfer stats for the given album.

See Also:

GetStats.execute(String, String[])

execute

public GetStats.GetStatsResponse execute(String url,
                                         String apiKey,
                                         String sessionID,
                                         Integer albumID,
                                         Integer month,
                                         Integer year,
                                         Boolean heavy)

Description copied from class: GetStats

Convenience method used to execute the smugmug.albums.getStats method.

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

Overrides:

execute in class GetStats

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.

albumID - The ID of the album to get the transfer stats for.

month - The number of the month (1-12) to get the transfer stats for the given album.

year - The year (e.g. 2007) to get the transfer stats for the given album.

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 the transfer stats for the given album and if the response is heavy, a list of transfer stats for each image in the album.

See Also:

GetStats.execute(String, String[])