io.javadog.cws.api.requests

Class ProcessCircleRequest

java.lang.Object

io.javadog.cws.api.requests.Verifiable

io.javadog.cws.api.requests.Authentication

io.javadog.cws.api.requests.ProcessCircleRequest

All Implemented Interfaces:

ActionRequest, CircleIdRequest, Serializable

public final class ProcessCircleRequest
extends Authentication
implements CircleIdRequest, ActionRequest

Circles only have an Id, a name and an optional External Circle Key, the Key is stored encrypted, if set. The name must be present, unique and between 1 and 75 characters long. When invoking the processCircle request, it is possible to perform the following actions:

• CREATE - For creating a new Circle
• UPDATE - For updating an existing Circle
• DELETE - For deleting an existing Circle

Action CREATE; request requires a name for the Circle, which must be unique, have a length between 1 & 75 characters. If a Member Id is also provided, then this will be the initial Circle Administrator. If no Member Id has been provided, then the requesting Member will be the initial Circle Administrator. It is also possible to set the Circle Key, which is an external Key, shared by the members of the Circle, it will be stored internally encrypted, but not used.

Action UPDATE; request requires the Circle Id, and optionally a new, unique, name for the Circle, with a length between 1 & 75 characters. It is also possible to update the (external) Circle Key, which means that the existing Circle Key will be replaced.

Action DELETE; request requires a Circle Id, and may be performed by anyone who have Administrative right in the Circle.

For more details, please see the 'processCircle' request in the Management interface: Management.processCircle(ProcessCircleRequest)

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessCircleRequest()

Method Summary

Modifier and Type	Method and Description
Action	getAction() Retrieves the Action for the current request.
String	getCircleId()
String	getCircleKey()
String	getCircleName()
String	getMemberId()
void	setAction(Action action) Defines the action which should be performed by the request.
void	setCircleId(String circleId)
void	setCircleKey(String circleKey)
void	setCircleName(String circleName)
void	setMemberId(String memberId)
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

ProcessCircleRequest

public ProcessCircleRequest()

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

setCircleId

public void setCircleId(String circleId)

Specified by:

setCircleId in interface CircleIdRequest

getCircleId

public String getCircleId()

Specified by:

getCircleId in interface CircleIdRequest

setCircleName

public void setCircleName(String circleName)

getCircleName

public String getCircleName()

setMemberId

public void setMemberId(String memberId)

getMemberId

public String getMemberId()

setCircleKey

public void setCircleKey(String circleKey)

getCircleKey

public String getCircleKey()

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