io.javadog.cws.api.requests

Class SanityRequest

java.lang.Object

io.javadog.cws.api.requests.Verifiable

io.javadog.cws.api.requests.Authentication

io.javadog.cws.api.requests.SanityRequest

All Implemented Interfaces:

CircleIdRequest, Serializable

public final class SanityRequest
extends Authentication
implements CircleIdRequest

The Sanity Request Object is needed to perform the Sanity CWS Request, which is a management request to see if any Data Object have been corrupted and thus rendered useless. The CircleId is an optional field, serves a way to limit the scope of the Objects retrieved.

Please see Authentication for information about the account and credentials information.

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SanityRequest()

Method Summary

Modifier and Type	Method and Description
String	getCircleId()
Date	getSince()
void	setCircleId(String circleId)
void	setSince(Date since)
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

SanityRequest

public SanityRequest()

Method Detail

setCircleId

public void setCircleId(String circleId)

Specified by:

setCircleId in interface CircleIdRequest

getCircleId

public String getCircleId()

Specified by:

getCircleId in interface CircleIdRequest

setSince

public void setSince(Date since)

getSince

public Date getSince()

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