Package com.sas.lsaf.clinical.dictionary

Class DictionaryDescriptor

java.lang.Object
com.sas.lsaf.core.AbstractIdentifiable
com.sas.lsaf.clinical.dictionary.DictionaryDescriptor
All Implemented Interfaces:
Identifiable, Serializable
public class DictionaryDescriptor extends AbstractIdentifiable
A lightweight version of the dictionary object.
Since:
2.2
See Also:

  • Constructor Details

    • DictionaryDescriptor

      public DictionaryDescriptor(String id, String name, String description, String standard, boolean isCheckedOut, String checkedOutBy, Date checkedOutDate, String createdBy, Date created, String lastModifiedBy, Date lastModified, String releaseDate, EntityState state, EntityState publishedState, EntityStatus dictionaryStatus, String currentVersion, int numStudiesAssociated)
      It is not intended or recommended that the consumer of the API construct these objects. They should only deal with the dictionary descriptors that are returned by the API.
      Parameters:
      id - The identifier of the dictionary.
      name - The name of the dictionary.
      description - The description of the dictionary.
      standard - The standard that the dictionary represents.
      isCheckedOut - Indicates whether the dictionary is checked out.
      checkedOutBy - The userId of the user who checked out the dictionary.
      checkedOutDate - The date on which the dictionary was checked out.
      createdBy - The userId of the user who created the dictionary.
      created - The date on which the dictionary was created.
      lastModifiedBy - The userId of the user who last modified the dictionary.
      lastModified - The date on which the dictionary was modified.
      releaseDate - The date on which the dictionary was released.
      state - The state of the dictionary.
      publishedState - The published state of the dictionary, if it has been published.
      dictionaryStatus - The status of the dictionary.
      currentVersion - The current published version of the dictionary.
      numStudiesAssociated - The number of studies that are associated with the dictionary.

  • Method Details

    • getNumStudiesAssociated

      public int getNumStudiesAssociated()
      Gets the number of studies that are associated with the dictionary.
      Returns:
      The number of studies that are associated with the dictionary.

    • getName

      public String getName()
      Gets the name of the dictionary.
      Returns:
      The name of the dictionary.

    • getDescription

      public String getDescription()
      Gets the description of the dictionary.
      Returns:
      The description of the dictionary.

    • getStandard

      public String getStandard()
      Gets the standard that the dictionary represents.
      Returns:
      The standard that the dictionary represents.

    • getCreatedBy

      public String getCreatedBy()
      Gets the userId of the user who created the dictionary.
      Returns:
      The userId of the user who created the dictionary.

    • getCreated

      public Date getCreated()
      Gets the date on which the dictionary was created.
      Returns:
      The date on which the dictionary was created.

    • isCheckedOut

      public boolean isCheckedOut()
      Indicates whether the dictionary is checked out.
      Returns:
      True, if the dictionary is checked out.

    • getCheckedOutBy

      public String getCheckedOutBy()
      Gets the userId of the user who checked out the dictionary.
      Returns:
      The userId of the user who checked out the dictionary.

    • getCheckedOutDate

      public Date getCheckedOutDate()
      Gets the date on which the dictionary was checked out.
      Returns:
      The date on which the dictionary was checked out.

    • getState

      public EntityState getState()
      Gets the state of the dictionary.
      Returns:
      The state of the dictionary.

    • getPublishedState

      public EntityState getPublishedState()
      Gets the published state of the dictionary, if it has been published. Otherwise, null.
      Returns:
      The published state of the dictionary, if it has been published.

    • getDictionaryStatus

      public EntityStatus getDictionaryStatus()
      Gets the status of the dictionary.
      Returns:
      The status of the dictionary.

    • getCurrentVersion

      public String getCurrentVersion()
      Gets the current published version of the dictionary. Returns 0, if the dictionary has not been published.
      Returns:
      The current published version of the dictionary. Returns 0, if the dictionary has not been published.

    • getLastModified

      public Date getLastModified()
      Gets the date on which the dictionary was last modified.
      Returns:
      The date on which the dictionary was last modified.

    • getLastModifiedBy

      public String getLastModifiedBy()
      Gets the userId of the user who last modified the dictionary.
      Returns:
      The userId of the user who last modified the dictionary.

    • getReleaseDate

      public String getReleaseDate()
      Gets the date on which the dictionary was released.
      Returns:
      The date on which the dictionary was released.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class AbstractIdentifiable

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractIdentifiable

    • toString

      public String toString()
      Overrides:
      toString in class AbstractIdentifiable