Package ch.systemsx.cisd.openbis.generic.server.jython.api.v1.impl

Class VocabularyImmutable

java.lang.Object

ch.systemsx.cisd.openbis.generic.server.jython.api.v1.impl.VocabularyImmutable

All Implemented Interfaces:

IVocabularyImmutable

Direct Known Subclasses:

Vocabulary

public class VocabularyImmutable
extends java.lang.Object
implements IVocabularyImmutable

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCode()	Returns the vocabulary code.
java.lang.String	getDescription()	Returns the vocabulary description.
java.util.List<IVocabularyTermImmutable>	getTerms()	Return a list with all terms within the vocabulary.
java.lang.String	getUrlTemplate()	Returns a URL template (e.g a search query) that can display additional information for the concrete vocabulary terms.
boolean	isChosenFromList()
boolean	isInternalNamespace()	Deprecated. use isManagedInternally()
boolean	isManagedInternally()	Return true if the vocabulary is managed internally in openBIS.

Methods inherited from class java.lang.Object

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

Method Detail

getCode

public java.lang.String getCode()

Description copied from interface: IVocabularyImmutable

Returns the vocabulary code.

Specified by:

getCode in interface IVocabularyImmutable

getDescription

public java.lang.String getDescription()

Description copied from interface: IVocabularyImmutable

Returns the vocabulary description.

Specified by:

getDescription in interface IVocabularyImmutable

isManagedInternally

public boolean isManagedInternally()

Description copied from interface: IVocabularyImmutable

Return true if the vocabulary is managed internally in openBIS.

Specified by:

isManagedInternally in interface IVocabularyImmutable

isInternalNamespace

@Deprecated
public boolean isInternalNamespace()

Deprecated.

use isManagedInternally()

Description copied from interface: IVocabularyImmutable

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

Specified by:

isInternalNamespace in interface IVocabularyImmutable

isChosenFromList

public boolean isChosenFromList()

Specified by:

isChosenFromList in interface IVocabularyImmutable

getUrlTemplate

public java.lang.String getUrlTemplate()

Description copied from interface: IVocabularyImmutable

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

Specified by:

getUrlTemplate in interface IVocabularyImmutable

getTerms

public java.util.List<IVocabularyTermImmutable> getTerms()

Description copied from interface: IVocabularyImmutable

Return a list with all terms within the vocabulary.

Specified by:

getTerms in interface IVocabularyImmutable