Package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto

Class Vocabulary

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Vocabulary

All Implemented Interfaces:

Serializable

@JsonObject("VocabularyGeneric")
public class Vocabulary
extends Object
implements Serializable

Immutable value object representing an openBIS vocabulary.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Vocabulary.VocabularyInitializer

Constructor Summary

Constructors

Constructor	Description
Vocabulary(Vocabulary.VocabularyInitializer initializer)	Creates a new instance with the provided initializer

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCode()	Returns the vocabulary code.
String	getDescription()	Returns the vocabulary description.
Long	getId()	Returns the vocabulary id.
List<VocabularyTerm>	getTerms()	Returns the vocabulary terms.
String	getUrlTemplate()	Returns a URL template (e.g a search query) that can display additional information for concrete vocabulary terms.
int	hashCode()
boolean	isChosenFromList()	Return true if the vocabulary was chosen from a list.
boolean	isInternalNamespace()	Deprecated. use isManagedInternally()
boolean	isManagedInternally()	Returns true if the vocabulary is managed internally.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Vocabulary

public Vocabulary(Vocabulary.VocabularyInitializer initializer)

Creates a new instance with the provided initializer

Throws:

IllegalArgumentException - if some of the required information is not provided.

Method Details

getId

public Long getId()

Returns the vocabulary id.

getCode

public String getCode()

Returns the vocabulary code.

getDescription

public String getDescription()

Returns the vocabulary description.

isManagedInternally

public boolean isManagedInternally()

Returns true if the vocabulary is managed internally.

isInternalNamespace

public boolean isInternalNamespace()

Deprecated.

use isManagedInternally()

Returns true if the vocabulary is in the internal openBIS namespace.

isChosenFromList

public boolean isChosenFromList()

Return true if the vocabulary was chosen from a list.

getUrlTemplate

public String getUrlTemplate()

Returns a URL template (e.g a search query) that can display additional information for concrete vocabulary terms.

getTerms

public List<VocabularyTerm> getTerms()

Returns the vocabulary terms.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object