com.konakartadmin.app

Class AdminImageOptions

java.lang.Object

com.konakartadmin.app.AdminImageOptions

public class AdminImageOptions
extends java.lang.Object

The AdminImageOptions is used to define the options for image APIs.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	crc CRC of the source image
private int	id The id (use the productId for operations on products, use manufacturerId for operations on manufacturers)
private java.lang.String	sourceFullFilename Full filename of the source image.
private int	subject The type of object for the image operation.
private java.lang.String	targetFilename Only used for removal of images.

Constructor Summary

Constructors

Constructor and Description
AdminImageOptions() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCrc()
int	getId()
java.lang.String	getSourceFullFilename()
int	getSubject()
java.lang.String	getTargetFilename()
void	setCrc(java.lang.String crc)
void	setId(int id)
void	setSourceFullFilename(java.lang.String sourceFullFilename)
void	setSubject(int subject)
void	setTargetFilename(java.lang.String targetFilename)
java.lang.String	toString()
java.lang.String	toStringBrief()

Methods inherited from class java.lang.Object

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

Field Detail

id

private int id

The id (use the productId for operations on products, use manufacturerId for operations on manufacturers)

sourceFullFilename

private java.lang.String sourceFullFilename

Full filename of the source image. Must be accessible to the Admin Engine.

crc

private java.lang.String crc

CRC of the source image

targetFilename

private java.lang.String targetFilename

Only used for removal of images.

Filename (or part of) of the image to operate on. If this value is specified as "*" then all images associated with the object (identified by id) will be deleted. This value should not include the path but only the file name (or part of) itself. It is used for searching for images so is used as a pattern for matching.

subject

private int subject

The type of object for the image operation. e.g. add or remove image for product, category or manufacturer. This must be set.

• IMG_PRODUCT = product (in which case the id must be the productId)
• IMG_MANUFACTURER = manufacturer (in which case the id must be the manufacturerId)
• IMG_CATEGORY = category (in which case the id must be the categoryId)

Constructor Detail

AdminImageOptions

public AdminImageOptions()

Constructor

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Option object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a brief string containing the attributes of the Option object.

getId

public int getId()

Returns:

the id

setId

public void setId(int id)

Parameters:

id - the id to set

getSourceFullFilename

public java.lang.String getSourceFullFilename()

Returns:

the sourceFullFilename

setSourceFullFilename

public void setSourceFullFilename(java.lang.String sourceFullFilename)

Parameters:

sourceFullFilename - the sourceFullFilename to set

getTargetFilename

public java.lang.String getTargetFilename()

Returns:

the targetFilename

setTargetFilename

public void setTargetFilename(java.lang.String targetFilename)

Parameters:

targetFilename - the targetFilename to set

getSubject

public int getSubject()

Returns:

the subject

setSubject

public void setSubject(int subject)

Parameters:

subject - the subject to set

getCrc

public java.lang.String getCrc()

Returns:

the crc

setCrc

public void setCrc(java.lang.String crc)

Parameters:

crc - the crc to set