com.cisco.thunderhead.dictionary

Class FieldSet

java.lang.Object

com.cisco.thunderhead.BaseBean

com.cisco.thunderhead.BaseDbBean<String>

com.cisco.thunderhead.dictionary.FieldSet

All Implemented Interfaces:

Comparable<BaseDbBean<String>>

public class FieldSet
extends BaseDbBean<String>

FieldSet groups together multiple fields into a type. PODs have a list of fieldsets to define what fields should be included in them.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_FIELDSET_PATH
static String	BASE_FIELDSET_SEARCH_PATH
static int	MAX_NUMBER_SEARCH_PARAMS
static boolean	PUBLICLY_ACCESSIBLE_DEFAULT If not specified, a Fieldset is publicly accessible

Constructor Summary

Constructors

Constructor and Description
FieldSet()
FieldSet(Set<String> fields, Boolean publiclyAccessible) Constructor for FieldSet
FieldSet(String identifier, Set<String> fields, Boolean publiclyAccessible) Constructor for FieldSet

Method Summary

Modifier and Type	Method and Description
void	convertAndSetId(String id)
String	getBeanUri()
Set<Field>	getFieldDefinitions() Get the set of fields defined by this fieldset
Set<String>	getFields() Get the set of fields in this FieldSet
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.
void	setFieldDefinitions(Set<Field> fieldDefinitions) Set the field definitions to the set of field objects
void	setFields(Set<String> fields) Set the set of fields in this FieldSet
void	setPubliclyAccessible(Boolean publiclyAccessible) Set Flag specifying if the element is globally accessible by all orgs or just the creator (org).

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

BASE_FIELDSET_PATH

public static final String BASE_FIELDSET_PATH

See Also:

Constant Field Values

BASE_FIELDSET_SEARCH_PATH

public static final String BASE_FIELDSET_SEARCH_PATH

See Also:

Constant Field Values

PUBLICLY_ACCESSIBLE_DEFAULT

public static final boolean PUBLICLY_ACCESSIBLE_DEFAULT

If not specified, a Fieldset is publicly accessible

See Also:

Constant Field Values

MAX_NUMBER_SEARCH_PARAMS

public static final int MAX_NUMBER_SEARCH_PARAMS

See Also:

Constant Field Values

Constructor Detail

FieldSet

public FieldSet()

FieldSet

public FieldSet(String identifier,
                Set<String> fields,
                Boolean publiclyAccessible)

Constructor for FieldSet

Parameters:

identifier - Identifier of this FieldSet

fields - Set of fields that are in this fieldset

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

FieldSet

public FieldSet(Set<String> fields,
                Boolean publiclyAccessible)

Constructor for FieldSet

Parameters:

fields - Set of fields that are in this fieldset

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

Method Detail

getBeanUri

public String getBeanUri()

Specified by:

getBeanUri in class BaseDbBean<String>

convertAndSetId

public void convertAndSetId(String id)

Specified by:

convertAndSetId in class BaseDbBean<String>

getRelURL

public static final String getRelURL(String id)

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

Parameters:

id - the id from which to construct the Re URL

Returns:

base URL.

getFields

public Set<String> getFields()

Get the set of fields in this FieldSet

Returns:

the Set of Fields in the FieldSet

setFields

public void setFields(Set<String> fields)

Set the set of fields in this FieldSet

Parameters:

fields - the Set of Fields in the FieldSet

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)

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

Parameters:

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

getFieldDefinitions

public Set<Field> getFieldDefinitions()

Get the set of fields defined by this fieldset

Returns:

setFieldDefinitions

public void setFieldDefinitions(Set<Field> fieldDefinitions)

Set the field definitions to the set of field objects

Parameters:

fieldDefinitions -