io.javadog.cws.api.requests

Class ProcessDataRequest

java.lang.Object

io.javadog.cws.api.requests.Verifiable

io.javadog.cws.api.requests.Authentication

io.javadog.cws.api.requests.ProcessDataRequest

All Implemented Interfaces:

ActionRequest, CircleIdRequest, Serializable

public final class ProcessDataRequest
extends Authentication
implements CircleIdRequest, ActionRequest

The Request Object supports several actions for adding, updating and deleting Data Objects in CWS. The request supports the following Actions:

• ADD - For adding a new Data Object
• UPDATE - For updating an existing Data Object
• DELETE - For deleting an existing Data Object

Action ADD; requires a Circle Id, and optionally a Folder Id (Data Id, where the dataType is a folder), and the name of the Object. The name must be between 1 and 75 characters, and it must be unique for the folder where it is added. As Objects created doesn't need to have any data, the data is optional.

Action UPDATE; requires the Data Id, and an optional Folder Id, if the Object is suppose to be moved within the internal folder structure, or a new Data name, which must be unique for the folder where it should be placed, and the length must be between 1 and 75 characters.

Action DELETE; requires the Data Id.

For more details, please see the 'processData' request in the Share interface: Share.processData(ProcessDataRequest)

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessDataRequest()

Method Summary

Modifier and Type	Method and Description
Action	getAction() Retrieves the Action for the current request.
String	getCircleId()
byte[]	getData()
String	getDataId()
String	getDataName()
String	getFolderId()
String	getTargetCircleId()
String	getTargetFolderId()
String	getTypeName()
void	setAction(Action action) Defines the action which should be performed by the request.
void	setCircleId(String circleId)
void	setData(byte[] data)
void	setDataId(String dataId)
void	setDataName(String dataName)
void	setFolderId(String folderId)
void	setTargetCircleId(String targetCircleId)
void	setTargetFolderId(String targetFolderId)
void	setTypeName(String typeName)
Map<String,String>	validate() Simple Validation method, which checks if the required values are usable or not.

Methods inherited from class io.javadog.cws.api.requests.Authentication

getAccountName, getCredential, getCredentialType, setAccountName, setCredential, setCredentialType

Methods inherited from class io.javadog.cws.api.requests.Verifiable

checkIntegerWithMax, checkNotNull, checkNotNullAndValidId, checkNotNullEmptyOrTooLong, checkNotNullOrEmpty, checkNotNullOrEmpty, checkNotTooLong, checkUrl, checkValidId, isEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessDataRequest

public ProcessDataRequest()

Method Detail

setAction

public void setAction(Action action)

Defines the action which should be performed by the request.

Specified by:

setAction in interface ActionRequest

Parameters:

action - The Action to be performed

getAction

public Action getAction()

Retrieves the Action for the current request.

Specified by:

getAction in interface ActionRequest

Returns:

The Action the request should perform

setDataId

public void setDataId(String dataId)

getDataId

public String getDataId()

setCircleId

public void setCircleId(String circleId)

Specified by:

setCircleId in interface CircleIdRequest

getCircleId

public String getCircleId()

Specified by:

getCircleId in interface CircleIdRequest

setTargetCircleId

public void setTargetCircleId(String targetCircleId)

getTargetCircleId

public String getTargetCircleId()

setDataName

public void setDataName(String dataName)

getDataName

public String getDataName()

setFolderId

public void setFolderId(String folderId)

getFolderId

public String getFolderId()

setTargetFolderId

public void setTargetFolderId(String targetFolderId)

getTargetFolderId

public String getTargetFolderId()

setTypeName

public void setTypeName(String typeName)

getTypeName

public String getTypeName()

setData

public void setData(byte[] data)

getData

public byte[] getData()

validate

public Map<String,String> validate()

Simple Validation method, which checks if the required values are usable or not.

Overrides:

validate in class Authentication

Returns:

Map with Fields and error information