com.clivern.wit.api

Class Entity

java.lang.Object

com.clivern.wit.api.Entity

All Implemented Interfaces:

Contract

public class Entity
extends java.lang.Object
implements Contract

Entity API

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	accessToken
java.lang.String	appId
java.lang.String	contentType
java.util.Map<java.lang.String,java.lang.String>	data
java.lang.String	endpointName
java.lang.String	entityId
java.lang.String	entityValue
java.lang.String	expressionValue
java.lang.String	finalData
java.util.Map<java.lang.String,java.lang.String>	headers
java.lang.String	method
java.lang.String	url

Constructor Summary

Constructors

Constructor and Description
Entity(java.lang.String endpointName) Class Constructor
Entity(java.lang.String endpointName, java.lang.String contentType) Class Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	config() Configure The API Call Info
java.lang.String	debug() Debug The Request This Used for Development Purposes and Shouldn't used in Production
java.lang.String	getAccessToken() Get Access Token
java.lang.String	getAppId() Get The App ID
java.lang.String	getData() Get The Data to Send
java.lang.String	getDoc() Get A Short sentence describing this entity
java.lang.String	getEntityId() Get the Entity ID
java.lang.String	getEntityValue() Get The Entity Value
java.lang.String	getExpression() Get Entity Value Expression
java.lang.String[]	getExpressions() Get Entity Value Expressions
java.lang.String	getExpressionValue() Get the Expression Value
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Get The Headers
java.lang.String	getId() Get The Entity Id
java.lang.String	getMetadata() Get A metadata to attach to Entity value
java.lang.String	getMethod() Get The Method
java.lang.String	getUrl() Get The URL
java.lang.String	getValue() Get Entity Value
java.lang.String[]	getValues() Get Entity Values
void	setAccessToken(java.lang.String accessToken) Set Access Token
void	setAppId(java.lang.String appId) Set App ID
void	setDoc(java.lang.String doc) Set A Short sentence describing this entity
void	setEntityId(java.lang.String entityId) Set the Entity ID
void	setEntityValue(java.lang.String entityValue) Set The Entity Value
void	setExpression(java.lang.String expression) Set Entity Value Expression
void	setExpressions(java.lang.String[] expressions) Set Entity Value Expressions
void	setExpressionValue(java.lang.String expressionValue) Set the Expression Value
void	setId(java.lang.String id) Set The Entity Id
void	setMetadata(java.lang.String metadata) Set A metadata to attach to Entity value
void	setValue(java.lang.String value) Set Entity Value
void	setValues(java.lang.String[] values) Set Entity Values

Methods inherited from class java.lang.Object

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

Field Detail

appId

public java.lang.String appId

accessToken

public java.lang.String accessToken

endpointName

public java.lang.String endpointName

contentType

public java.lang.String contentType

url

public java.lang.String url

method

public java.lang.String method

data

public java.util.Map<java.lang.String,java.lang.String> data

finalData

public java.lang.String finalData

headers

public java.util.Map<java.lang.String,java.lang.String> headers

entityId

public java.lang.String entityId

entityValue

public java.lang.String entityValue

expressionValue

public java.lang.String expressionValue

Constructor Detail

Entity

public Entity(java.lang.String endpointName)

Class Constructor

Parameters:

endpointName - The Endpoint Name

Entity

public Entity(java.lang.String endpointName,
              java.lang.String contentType)

Class Constructor

Parameters:

endpointName - The Endpoint Name

contentType - The Content Type

Method Detail

config

public java.lang.Boolean config()
                         throws DataNotValid,
                                DataNotFound

Configure The API Call Info

Specified by:

config in interface Contract

Returns:

Boolean Whether Call Will be Valid or Not

Throws:

DataNotValid - Invalid Data Within The Request

DataNotFound - Some Data are Missing

getUrl

public java.lang.String getUrl()

Get The URL

Specified by:

getUrl in interface Contract

Returns:

String The URL

getMethod

public java.lang.String getMethod()

Get The Method

Specified by:

getMethod in interface Contract

Returns:

String The Method

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Get The Headers

Specified by:

getHeaders in interface Contract

Returns:

Map The Headers

getData

public java.lang.String getData()

Get The Data to Send

Specified by:

getData in interface Contract

Returns:

String The Data to Send

getAppId

public java.lang.String getAppId()

Get The App ID

Specified by:

getAppId in interface Contract

Returns:

String The App ID

getAccessToken

public java.lang.String getAccessToken()

Get Access Token

Specified by:

getAccessToken in interface Contract

Returns:

String The Access Token

setAppId

public void setAppId(java.lang.String appId)

Set App ID

Specified by:

setAppId in interface Contract

Parameters:

appId - Application ID

setAccessToken

public void setAccessToken(java.lang.String accessToken)

Set Access Token

Specified by:

setAccessToken in interface Contract

Parameters:

accessToken - Access Token

setEntityId

public void setEntityId(java.lang.String entityId)

Set the Entity ID

Parameters:

entityId - The Entity Id

setEntityValue

public void setEntityValue(java.lang.String entityValue)

Set The Entity Value

Parameters:

entityValue - The Entity Value

setExpressionValue

public void setExpressionValue(java.lang.String expressionValue)

Set the Expression Value

Parameters:

expressionValue - The Expression Value

setId

public void setId(java.lang.String id)

Set The Entity Id

Parameters:

id - The Entity id

setDoc

public void setDoc(java.lang.String doc)

Set A Short sentence describing this entity

Parameters:

doc - A Short sentence describing this entity

setValues

public void setValues(java.lang.String[] values)

Set Entity Values

Parameters:

values - Entity Values

setValue

public void setValue(java.lang.String value)

Set Entity Value

Parameters:

value - Entity Value

setExpressions

public void setExpressions(java.lang.String[] expressions)

Set Entity Value Expressions

Parameters:

expressions - Entity Value Expressions

setMetadata

public void setMetadata(java.lang.String metadata)

Set A metadata to attach to Entity value

Parameters:

metadata - A metadata value to be attached to Entity value

setExpression

public void setExpression(java.lang.String expression)

Set Entity Value Expression

Parameters:

expression - Entity Value Expression

getEntityId

public java.lang.String getEntityId()

Get the Entity ID

Returns:

String The Entity Id

getEntityValue

public java.lang.String getEntityValue()

Get The Entity Value

Returns:

String The Entity Value

getExpressionValue

public java.lang.String getExpressionValue()

Get the Expression Value

Returns:

String The Expression Value

getId

public java.lang.String getId()

Get The Entity Id

Returns:

String The Entity id

getDoc

public java.lang.String getDoc()

Get A Short sentence describing this entity

Returns:

String A Short sentence describing this entity

getValues

public java.lang.String[] getValues()

Get Entity Values

Returns:

ArrayList Entity Values

getValue

public java.lang.String getValue()

Get Entity Value

Returns:

String Entity Value

getExpressions

public java.lang.String[] getExpressions()

Get Entity Value Expressions

Returns:

ArrayList Entity Value Expressions

getMetadata

public java.lang.String getMetadata()

Get A metadata to attach to Entity value

Returns:

String A metadata value to be attached to Entity value

getExpression

public java.lang.String getExpression()

Get Entity Value Expression

Returns:

String Entity Value Expression

debug

public java.lang.String debug()

Debug The Request This Used for Development Purposes and Shouldn't used in Production

Specified by:

debug in interface Contract

Returns:

String The debug data