Package org.openehealth.ipf.commons.ihe.xds.core.ebxml

Interface EbXMLRegistryObject

All Superinterfaces:
EbXMLSlotList
All Known Subinterfaces:
EbXMLAssociation, EbXMLExtrinsicObject, EbXMLRegistryPackage
All Known Implementing Classes:
EbXMLAssociation30, EbXMLExtrinsicObject30, EbXMLRegistryObject30, EbXMLRegistryPackage30
public interface EbXMLRegistryObject extends EbXMLSlotList
Encapsulation of the ebXML classes for RegistryEntryType and RegistryObjectType.

This class contains convenience methods and provides a version independent abstraction of the ebXML data structure.

Author:
Jens Riemschneider

  • Method Details

    • getClassifications

      List<EbXMLClassification> getClassifications()
      Returns:
      all classifications contained in this entry.

    • getClassifications

      List<EbXMLClassification> getClassifications(String scheme)
      Returns the classification matching the given scheme.
      Parameters:
      scheme - the scheme.
      Returns:
      the classifications contained in this entry that match the scheme.

    • getSingleClassification

      EbXMLClassification getSingleClassification(String scheme)
      Returns the first classification matching the given scheme.
      Parameters:
      scheme - the scheme.
      Returns:
      the classification matching the scheme. Only the first classification is considered, other classifications are ignored.

    • addClassification

      void addClassification(EbXMLClassification classification, String scheme)
      Adds a classification to this entry with a random id.
      Parameters:
      classification - the classification to add.
      scheme - the scheme of the classification.

    • getExternalIdentifiers

      List<EbXMLExternalIdentifier> getExternalIdentifiers()
      Returns:
      all external identifiers contained in this entry.

    • getExternalIdentifierValue

      String getExternalIdentifierValue(String scheme)
      Returns the value of the external identifier matching the given scheme.
      Parameters:
      scheme - the scheme of the external identifier.
      Returns:
      the value of the external identifier that matched the scheme. null if no identifier was found that matched the scheme.

    • addExternalIdentifier

      void addExternalIdentifier(String value, String scheme, String name)
      Adds a new external identifier to this entry.
      Parameters:
      value - the value of the identifier.
      scheme - the scheme of the identifier.
      name - the name of the identifier.

    • getObjectType

      String getObjectType()
      Returns:
      the object type of this entry.

    • setObjectType

      void setObjectType(String objectType)
      Parameters:
      objectType - the object type of this entry.

    • getDescription

      LocalizedString getDescription()
      Returns:
      the description of this entry.

    • setDescription

      void setDescription(LocalizedString description)
      Parameters:
      description - the description of this entry.

    • getName

      LocalizedString getName()
      Returns:
      the name of this entry.

    • setName

      void setName(LocalizedString name)
      Parameters:
      name - the name of this entry.

    • getHome

      String getHome()
      Returns:
      the home attribute of this entry.

    • setHome

      void setHome(String home)
      Parameters:
      home - the home attribute of this entry.

    • getId

      String getId()
      Returns:
      the id of this entry.

    • setId

      void setId(String id)
      Parameters:
      id - the id of this entry.

    • getLid

      String getLid()
      Returns:
      the lid of this entry.

    • setLid

      void setLid(String lid)
      Parameters:
      lid - the lid of this entry.

    • getVersionInfo

      Version getVersionInfo()
      Returns:
      the id of this entry.

    • setVersionInfo

      void setVersionInfo(Version version)
      Parameters:
      version - the versionInfo of this entry.

    • getInternal

      Object getInternal()
      Returns:
      the ebXML object being wrapped by this entry.