Interface IVocabularyImmutable
-
- All Known Subinterfaces:
IVocabulary
- All Known Implementing Classes:
Vocabulary,VocabularyImmutable
public interface IVocabularyImmutableRead-only interface to a vocabulary.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetCode()Returns the vocabulary code.java.lang.StringgetDescription()Returns the vocabulary description.java.util.List<IVocabularyTermImmutable>getTerms()Return a list with all terms within the vocabulary.java.lang.StringgetUrlTemplate()Returns a URL template (e.g a search query) that can display additional information for the concrete vocabulary terms.booleanisChosenFromList()booleanisInternalNamespace()Returntrueif the vocabulary is in the internal openBIS namespace.booleanisManagedInternally()Returntrueif the vocabulary is managed internally in openBIS.
-
-
-
Method Detail
-
getCode
java.lang.String getCode()
Returns the vocabulary code.
-
getDescription
java.lang.String getDescription()
Returns the vocabulary description.
-
isManagedInternally
boolean isManagedInternally()
Returntrueif the vocabulary is managed internally in openBIS.
-
isInternalNamespace
boolean isInternalNamespace()
Returntrueif the vocabulary is in the internal openBIS namespace.
-
isChosenFromList
boolean isChosenFromList()
-
getUrlTemplate
java.lang.String getUrlTemplate()
Returns a URL template (e.g a search query) that can display additional information for the concrete vocabulary terms. Can return null.
-
getTerms
java.util.List<IVocabularyTermImmutable> getTerms()
Return a list with all terms within the vocabulary.
-
-