com.electrotank.electroserver5.extensions.api
Class LanguageFilterResponse

java.lang.Object
  com.electrotank.electroserver5.extensions.api.LanguageFilterResponse

public class LanguageFilterResponse
extends Object

LanguageFilterResponse is an object returned by the api. Typically this is in response to an ElectroServerApi.applyLanguageFilterToString request, and indicates the success or failure of the call.

See Also:

ElectroServerApi.applyLanguageFilterToString, ElectroServer 4 Manual, Language Filter

Constructor Summary

LanguageFilterResponse(boolean isStringValid)
Creates a new instance of LanguageFilterResponse.

LanguageFilterResponse(com.electrotank.electroserver5.enumerations.ErrorType errorIn)
Creates a new instance of LanguageFilterResponse.

Method Summary

com.electrotank.electroserver5.enumerations.ErrorType	getError() Used to get the error for the request
boolean	isStringValid() Used to get the stringValid field of the object.
boolean	isSuccessful() Used to get the isSuccessful field of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LanguageFilterResponse

public LanguageFilterResponse(com.electrotank.electroserver5.enumerations.ErrorType errorIn)

Creates a new instance of LanguageFilterResponse. This constructor is suitable for a nonsuccessful response.

Parameters:

errorIn - an ErrorType object, with details on the error

LanguageFilterResponse

public LanguageFilterResponse(boolean isStringValid)

Creates a new instance of LanguageFilterResponse. This constructor is suitable for a successful response.

Parameters:

isStringValid - whether the String is valid

Method Detail

isStringValid

public boolean isStringValid()

Used to get the stringValid field of the object.

Returns:

stringValid true if the String was valid

getError

public com.electrotank.electroserver5.enumerations.ErrorType getError()

Used to get the error for the request

Returns:

ErrorType object

isSuccessful

public boolean isSuccessful()

Used to get the isSuccessful field of the object.

Returns:

true if the request was successful