Package com.sas.lsaf.clinical.dictionary

Class ExternalDictionary

java.lang.Object
com.sas.lsaf.core.AbstractIdentifiable
com.sas.lsaf.clinical.dictionary.ExternalDictionary
All Implemented Interfaces:
Identifiable, Serializable
public class ExternalDictionary extends AbstractIdentifiable
An external dictionary is a reference to an industry standard dictionary such as MedDRA and WHODRUG. The reference information includes the version number. The values in the external dictionaries are used by SAS Life Science Analytics Framework, but the values are not stored in SAS Life Science Analytics Framework.
Since:
2.2
See Also:

  • Constructor Details

    • ExternalDictionary

      public ExternalDictionary(String id, String dictionary, String version, DataType dataType, String shortName, String name, String href, String description, String createdBy, Date created, String lastModifiedBy, Date lastModified, int numStudiesAssociated)
      It is not intended or recommended that the consumer of the API construct these objects. They should only deal with the external dictionaries returned by the API.
      Parameters:
      id - The identifier of the external dictionary.
      dictionary - The name of the external dictionary.
      version - The version of the external dictionary.
      dataType - The data type of the external dictionary.
      shortName - The short name of the external dictionary.
      name - The reference name of the external dictionary.
      href - The href of the external dictionary.
      description - The description of the external dictionary.
      createdBy - The userId of the user who created the external dictionary.
      created - The date on which the external dictionary was created.
      lastModifiedBy - The userId of the user who last modified the external dictionary.
      lastModified - The date on which the external dictionary was modified.
      numStudiesAssociated - The number of studies that are associated with the external dictionary.

  • Method Details

    • getShortName

      public String getShortName()
      Gets the short name of the external dictionary.
      Returns:
      The short name of the external dictionary.

    • getName

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

    • getDictionary

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

    • getVersion

      public String getVersion()
      Gets the version of the external dictionary.
      Returns:
      The version of the external dictionary.

    • getHref

      public String getHref()
      Gets the href of the external dictionary.
      Returns:
      The href of the external dictionary.

    • getDescription

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

    • getCreatedBy

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

    • getCreated

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

    • getLastModified

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

    • getLastModifiedBy

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

    • getDataType

      public DataType getDataType()
      Gets the data type of the external dictionary.
      Returns:
      The data type of the external dictionary.

    • getNumStudiesAssociated

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractIdentifiable

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class AbstractIdentifiable