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

java.lang.Object
  extended by ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Vocabulary
All Implemented Interfaces:
java.io.Serializable

@JsonObject(value="VocabularyGeneric")
public class Vocabulary
extends java.lang.Object
implements java.io.Serializable

Immutable value object representing an openBIS vocabulary.

See Also:
Serialized Form

Nested Class Summary
static class Vocabulary.VocabularyInitializer
           
 
Constructor Summary
Vocabulary(Vocabulary.VocabularyInitializer initializer)
          Creates a new instance with the provided initializer
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getCode()
          Returns the vocabulary code.
 java.lang.String getDescription()
          Returns the vocabulary description.
 java.lang.Long getId()
          Returns the vocabulary id.
 java.util.List<VocabularyTerm> getTerms()
          Returns the vocabulary terms.
 java.lang.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()
          Returns true if the vocabulary is in the internal openBIS namespace.
 boolean isManagedInternally()
          Returns true if the vocabulary is managed internally.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Vocabulary

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

Throws:
java.lang.IllegalArgumentException - if some of the required information is not provided.
Method Detail

getId

public java.lang.Long getId()
Returns the vocabulary id.


getCode

public java.lang.String getCode()
Returns the vocabulary code.


getDescription

public java.lang.String getDescription()
Returns the vocabulary description.


isManagedInternally

public boolean isManagedInternally()
Returns true if the vocabulary is managed internally.


isInternalNamespace

public boolean isInternalNamespace()
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 java.lang.String getUrlTemplate()
Returns a URL template (e.g a search query) that can display additional information for concrete vocabulary terms.


getTerms

public java.util.List<VocabularyTerm> getTerms()
Returns the vocabulary terms.


equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object