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

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

All Implemented Interfaces:

Method

public class Rename
extends Rename

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

Version:

1.2.1

Author:

Riyad Kalla

See Also:

Rename

Nested Class Summary

class

Rename.RenameResponse This class is a convenience class extending the base Rename.RenameResponse implementation.

Field Summary

Fields inherited from class com.kallasoft.smugmug.api.json.v1_2_0.subcategories.Rename

ARGUMENTS, METHOD_NAME

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

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)

Description copied from class: Rename

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

Specified by:

execute in interface Method

Overrides:

execute in class Rename

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)

Description copied from class: Rename

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

Overrides:

execute in class Rename

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:

Rename.execute(String, String[])