com.kallasoft.smugmug.api.json.v1_2_0.subcategories
Class Rename

java.lang.Object
  com.kallasoft.smugmug.api.json.AbstractMethod
      com.kallasoft.smugmug.api.json.v1_2_0.subcategories.Rename

All Implemented Interfaces:

Method

Direct Known Subclasses:

Rename

public class Rename
extends AbstractMethod

This method renames the specified SubCategory with new Name.

Version:

1.2.0

Author:

Riyad Kalla

See Also:

smugmug.subcategories.rename API Doc

Nested Class Summary

class

Rename.RenameResponse Class used to represent the response for the smugmug.categories.rename method call.

Field Summary

static String[]	ARGUMENTS Defines all the arguments this method takes.
static String	METHOD_NAME Defines the SmugMug JSON API method name that will be called.

Constructor Summary

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

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

Method Summary

Rename.RenameResponse	execute(String url, String[] argumentValues) Used to execute the smugmug.subcategories.rename method, renaming the given subcategory with the given name.
Rename.RenameResponse	execute(String url, String apiKey, String sessionID, Integer subCategoryID, String name) Convenience method used to execute the smugmug.subcategories.rename method, renaming the given subcategory with the given name.

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

Field Detail

METHOD_NAME

public static final String METHOD_NAME

Defines the SmugMug JSON API method name that will be called.

See Also:

Constant Field Values

ARGUMENTS

public static final String[] ARGUMENTS

Defines all the arguments this method takes.

Values are: "APIKey", "SessionID", "SubCategoryID", "Name"

Constructor Detail

Rename

public Rename()

Construct a new method instance that can be executed.

Rename

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

Used to execute the smugmug.subcategories.rename method, renaming the given subcategory with the given name.

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 status of the operation.

execute

public Rename.RenameResponse execute(String url,
                                     String apiKey,
                                     String sessionID,
                                     Integer subCategoryID,
                                     String name)

Convenience method used to execute the smugmug.subcategories.rename method, renaming the given subcategory with the given name.

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

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.

subCategoryID - The ID of the subcategory that will be deleted.

name - The new name for the subcategory.

Returns:

the response that includes the status of the operation.

See Also:

execute(String, String[])