com.cisco.thunderhead.dictionary

Class Field

java.lang.Object

com.cisco.thunderhead.BaseBean

com.cisco.thunderhead.BaseDbBean<String>

com.cisco.thunderhead.dictionary.Field

All Implemented Interfaces:

Comparable<BaseDbBean<String>>

public class Field
extends BaseDbBean<String>

JSON interface to the Dictionary Field API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_DICTIONARY_FIELD_PATH
static String	BASE_DICTIONARY_SEARCH_PATH
static String	DATATYPE_DEFAULT
static String	ID
static int	MAX_NUMBER_SEARCH_PARAMS
static boolean	PUBLICLY_ACCESSIBLE_DEFAULT
static String	QUERY_DELIMITER
static String	QUERY_DELIMITER_DECODED
static String	QUERY_KEY
static String	QUERY_SEPARATOR
static String	SEARCHABLE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
Field() Default Constructor
Field(String identifier, String classification, String dataType, Boolean publiclyAccessible, Map<String,Object> translations) Parameterized Constructor
Field(String identifier, String classification, String dataType, Boolean publiclyAccessible, Map<String,Object> translations, String searchable, List<String> locales) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	changeToTranslationsMap(Map<String,String> translationsStr) Converts a String map to a LanguageType map.
void	convertAndSetId(String id)
String	getBeanUri()
String	getClassification() Returns the Element classification value - protected, pii, or restricted - enumeration coming soon.
String	getDataType() Element data type - int, double, string.
String	getIdentifier() Returns the Field id.
List<String>	getLocales()
Boolean	getPubliclyAccessible() Flag specifying if the element is globally accessible by all orgs or just the creator (org).
static String	getRelURL(String id) Returns the relative base url for the given id.
Restriction	getRestriction() Further restricts the value of the field on top of what is restricted by the data type.
String	getSearchable() Flag specifying if the element is searchable .
Map<String,Object>	getTranslations() Map of ISO code to translation for the element.
void	setClassification(String classification)
void	setDataType(String dataType)
void	setIdentifier(String identifier)
void	setLocales(List<String> locales)
void	setPubliclyAccessible(Boolean publiclyAccessible)
void	setSearchable(String searchable)
void	setTranslations(Map<String,Object> translations)

Methods inherited from class com.cisco.thunderhead.BaseDbBean

compareTo, getId, getKey, getLastUpdated, getRefURL, setId, setKey, setLastUpdated, setRefURL

Methods inherited from class com.cisco.thunderhead.BaseBean

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

QUERY_DELIMITER

public static final String QUERY_DELIMITER

See Also:

Constant Field Values

QUERY_DELIMITER_DECODED

public static final String QUERY_DELIMITER_DECODED

See Also:

Constant Field Values

QUERY_SEPARATOR

public static final String QUERY_SEPARATOR

See Also:

Constant Field Values

QUERY_KEY

public static final String QUERY_KEY

See Also:

Constant Field Values

MAX_NUMBER_SEARCH_PARAMS

public static final int MAX_NUMBER_SEARCH_PARAMS

See Also:

Constant Field Values

PUBLICLY_ACCESSIBLE_DEFAULT

public static final boolean PUBLICLY_ACCESSIBLE_DEFAULT

See Also:

Constant Field Values

DATATYPE_DEFAULT

public static final String DATATYPE_DEFAULT

See Also:

Constant Field Values

BASE_DICTIONARY_FIELD_PATH

public static final String BASE_DICTIONARY_FIELD_PATH

See Also:

Constant Field Values

BASE_DICTIONARY_SEARCH_PATH

public static final String BASE_DICTIONARY_SEARCH_PATH

See Also:

Constant Field Values

SEARCHABLE_DEFAULT

public static final String SEARCHABLE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

Field

public Field()

Default Constructor

Field

public Field(String identifier,
             String classification,
             String dataType,
             Boolean publiclyAccessible,
             Map<String,Object> translations)

Parameterized Constructor

Parameters:

identifier - unique element id

classification - element classification value

dataType - element data type

publiclyAccessible - globally accessible flag.

translations - map of ISO code to translation for the element

Field

public Field(String identifier,
             String classification,
             String dataType,
             Boolean publiclyAccessible,
             Map<String,Object> translations,
             String searchable,
             List<String> locales)

Parameterized Constructor

Parameters:

identifier - unique element id

classification - element classification value

dataType - element data type

publiclyAccessible - globally accessible flag.

translations - map of ISO code to translation for the element

searchable - flag indicating if an element is searchable or not

locales - list of locales an element can be searched on

Method Detail

getIdentifier

public String getIdentifier()

Returns the Field id.

Returns:

Field id

setIdentifier

public void setIdentifier(String identifier)

getClassification

public String getClassification()

Returns the Element classification value - protected, pii, or restricted - enumeration coming soon.

Returns:

element classification value

setClassification

public void setClassification(String classification)

getDataType

public String getDataType()

Element data type - int, double, string.

Returns:

element data type

setDataType

public void setDataType(String dataType)

getRestriction

public Restriction getRestriction()

Further restricts the value of the field on top of what is restricted by the data type.

Returns:

The restriction or null if there is no restriction.

getPubliclyAccessible

public Boolean getPubliclyAccessible()

Flag specifying if the element is globally accessible by all orgs or just the creator (org).

Returns:

flag specifying if the element is globally accessible

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)

getTranslations

public Map<String,Object> getTranslations()

Map of ISO code to translation for the element.

Returns:

translations

setTranslations

public void setTranslations(Map<String,Object> translations)

convertAndSetId

public void convertAndSetId(String id)

Specified by:

convertAndSetId in class BaseDbBean<String>

getSearchable

public String getSearchable()

Flag specifying if the element is searchable .

Returns:

flag specifying if the element is searchable

setSearchable

public void setSearchable(String searchable)

getLocales

public List<String> getLocales()

setLocales

public void setLocales(List<String> locales)

getBeanUri

public String getBeanUri()

Specified by:

getBeanUri in class BaseDbBean<String>

changeToTranslationsMap

public static Map<String,Object> changeToTranslationsMap(Map<String,String> translationsStr)

Converts a String map to a LanguageType map.

Parameters:

translationsStr - is the String map

Returns:

Map is the LanguageType map

getRelURL

public static final String getRelURL(String id)

Returns the relative base url for the given id.
i.e. /dictionary/field/v1/

Parameters:

id - the id from which to construct the base URL

Returns:

base URL.