io.javadog.cws.api.requests

Class ProcessTrusteeRequest

java.lang.Object

io.javadog.cws.api.requests.Verifiable

io.javadog.cws.api.requests.Authentication

io.javadog.cws.api.requests.ProcessTrusteeRequest

All Implemented Interfaces:

ActionRequest, CircleIdRequest, Serializable

public final class ProcessTrusteeRequest
extends Authentication
implements CircleIdRequest, ActionRequest

Request Object for the processing of Trustee's. It supports the following actions:

• ADD - For adding a new Trustee
• ALTER - For altering an existing Trustee
• REMOVE - For removing an existing Trustee

Action ADD; requires that both the Circle & Member Id's are provided, together with the TrustLevel, for the new Trustee.

Action ALTER; requires that both the Circle & Member Id's are provided, together with the new TrustLevel setting for the Trustee.

Action REMOVE; requires that both the Circle & Member Id's are provided, so the relation can be removed.

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

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessTrusteeRequest()

Method Summary

Modifier and Type	Method and Description
Action	getAction() Retrieves the Action for the current request.
String	getCircleId()
String	getMemberId()
TrustLevel	getTrustLevel()
void	setAction(Action action) Defines the action which should be performed by the request.
void	setCircleId(String circleId)
void	setMemberId(String memberId)
void	setTrustLevel(TrustLevel trustLevel)
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

ProcessTrusteeRequest

public ProcessTrusteeRequest()

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

setTrustLevel

public void setTrustLevel(TrustLevel trustLevel)

getTrustLevel

public TrustLevel getTrustLevel()

setCircleId

public void setCircleId(String circleId)

Specified by:

setCircleId in interface CircleIdRequest

getCircleId

public String getCircleId()

Specified by:

getCircleId in interface CircleIdRequest

setMemberId

public void setMemberId(String memberId)

getMemberId

public String getMemberId()

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