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

java.lang.Object
  extended by com.kallasoft.smugmug.api.json.AbstractMethod
      extended by com.kallasoft.smugmug.api.json.v1_2_0.albums.ReSort
          extended by com.kallasoft.smugmug.api.json.v1_2_1.albums.ReSort
All Implemented Interfaces:
Method

public class ReSort
extends ReSort

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

Version:
1.2.1
Author:
Riyad Kalla
See Also:
ReSort

Nested Class Summary
 class ReSort.ReSortResponse
          This class is a convenience class extending the base ReSort.ReSortResponse implementation.
 
Field Summary
 
Fields inherited from class com.kallasoft.smugmug.api.json.v1_2_0.albums.ReSort
ARGUMENTS, BY_CAPTION, BY_DATE_TIME, BY_FILE_NAME, DIRECTION_ASCENDING, DIRECTION_DESCENDING, METHOD_NAME
 
Constructor Summary
ReSort()
          Construct a new method instance that can be executed.
ReSort(String methodName, String[] arguments)
          Construct a new method instance that can be executed with the given arguments.
 
Method Summary
 ReSort.ReSortResponse execute(String url, String[] argumentValues)
          Used to execute the smugmug.albums.reSort method, returning confirmation that the sort has been executed.
 ReSort.ReSortResponse execute(String url, String apiKey, String sessionID, Integer albumID, String by, String direction)
          Convenience method used to execute the smugmug.albums.reSort method, returning confirmation that the sort has been executed.
 
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

ReSort

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


ReSort

public ReSort(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 ReSort.ReSortResponse execute(String url,
                                     String[] argumentValues)
Description copied from class: ReSort
Used to execute the smugmug.albums.reSort method, returning confirmation that the sort has been executed.

Specified by:
execute in interface Method
Overrides:
execute in class ReSort
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 a status of the sort operation.

execute

public ReSort.ReSortResponse execute(String url,
                                     String apiKey,
                                     String sessionID,
                                     Integer albumID,
                                     String by,
                                     String direction)
Description copied from class: ReSort
Convenience method used to execute the smugmug.albums.reSort method, returning confirmation that the sort has been executed.

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

Overrides:
execute in class ReSort
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 sort.
by - The method to sort the album by. See BY_XXX constants defined in this class.
direction - The direction to sort of the album by. See DIRECTION_XXX constants defined in this class.
Returns:
the response that includes a status of the sort operation.
See Also:
ReSort.execute(String, String[])