org.lexevs.dao.database.service.entity
Interface EntityService

All Known Implementing Classes:
VersionableEventEntityService

public interface EntityService

The Interface EntityService.

Author:
Kevin Peterson

Field Summary
static java.lang.String INSERT_BATCH_ENTITY_ERROR
           
static java.lang.String INSERT_ENTITY_DEPENDENT_CHANGES_ERROR
           
static java.lang.String INSERT_ENTITY_ERROR
           
static java.lang.String INSERT_ENTITY_VERSIONABLE_CHANGES_ERROR
           
static java.lang.String REMOVE_ENTITY_ERROR
           
static java.lang.String UPDATE_ENTITY_ERROR
           
 
Method Summary
 AssociationEntity getAssociationEntity(java.lang.String codingSchemeUri, java.lang.String version, java.lang.String entityCode, java.lang.String entityCodeNamespace)
           
 java.util.List<? extends Entity> getEntities(java.lang.String codingSchemeUri, java.lang.String version, int start, int pageSize)
          Gets the entities.
 Entity getEntity(java.lang.String codingSchemeUri, java.lang.String version, java.lang.String entityCode, java.lang.String entityCodeNamespace)
          Gets the entity.
 Entity getEntity(java.lang.String codingSchemeUri, java.lang.String version, java.lang.String entityCode, java.lang.String entityCodeNamespace, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyTypes)
           
 int getEntityCount(java.lang.String codingSchemeUri, java.lang.String version)
          Gets the entity count.
 EntityDescription getEntityDescription(java.lang.String codingSchemeURI, java.lang.String version, java.lang.String code, java.lang.String codeNamespace)
           
 ResolvedConceptReference getResolvedCodedNodeReference(java.lang.String codingSchemeUri, java.lang.String version, java.lang.String entityCode, java.lang.String entityCodeNamespace, boolean resolve, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyTypes)
           
 void insertBatchEntities(java.lang.String codingSchemeUri, java.lang.String version, java.util.List<? extends Entity> entities)
          Insert batch entities.
 void insertEntity(java.lang.String codingSchemeUri, java.lang.String version, Entity entity)
          Insert entity.
 void removeEntity(java.lang.String codingSchemeUri, java.lang.String version, Entity entity)
           
 Entity resolveEntityByDate(java.lang.String codingSchemeURI, java.lang.String version, java.lang.String entityCode, java.lang.String entityCodeNamespace, java.sql.Date date)
           
 Entity resolveEntityByRevision(java.lang.String codingSchemeURI, java.lang.String version, java.lang.String entityCode, java.lang.String entityCodeNamespace, java.lang.String revisionId)
           
 void revise(java.lang.String codingSchemeUri, java.lang.String version, Entity revisedEntity)
           
 void updateEntity(java.lang.String codingSchemeUri, java.lang.String version, Entity entity)
          Update entity.
 

Field Detail

INSERT_ENTITY_ERROR

static final java.lang.String INSERT_ENTITY_ERROR
See Also:
Constant Field Values

INSERT_BATCH_ENTITY_ERROR

static final java.lang.String INSERT_BATCH_ENTITY_ERROR
See Also:
Constant Field Values

UPDATE_ENTITY_ERROR

static final java.lang.String UPDATE_ENTITY_ERROR
See Also:
Constant Field Values

REMOVE_ENTITY_ERROR

static final java.lang.String REMOVE_ENTITY_ERROR
See Also:
Constant Field Values

INSERT_ENTITY_VERSIONABLE_CHANGES_ERROR

static final java.lang.String INSERT_ENTITY_VERSIONABLE_CHANGES_ERROR
See Also:
Constant Field Values

INSERT_ENTITY_DEPENDENT_CHANGES_ERROR

static final java.lang.String INSERT_ENTITY_DEPENDENT_CHANGES_ERROR
See Also:
Constant Field Values
Method Detail

insertEntity

void insertEntity(java.lang.String codingSchemeUri,
                  java.lang.String version,
                  Entity entity)
Insert entity.

Parameters:
codingSchemeUri - the coding scheme uri
version - the version
entity - the entity

getEntityCount

int getEntityCount(java.lang.String codingSchemeUri,
                   java.lang.String version)
Gets the entity count.

Parameters:
codingSchemeUri - the coding scheme uri
version - the version
Returns:
the entity count

getEntity

Entity getEntity(java.lang.String codingSchemeUri,
                 java.lang.String version,
                 java.lang.String entityCode,
                 java.lang.String entityCodeNamespace)
Gets the entity.

Parameters:
codingSchemeUri - the coding scheme uri
version - the version
entityCode - the entity code
entityCodeNamespace - the entity code namespace
Returns:
the entity

getEntity

Entity getEntity(java.lang.String codingSchemeUri,
                 java.lang.String version,
                 java.lang.String entityCode,
                 java.lang.String entityCodeNamespace,
                 java.util.List<java.lang.String> propertyNames,
                 java.util.List<java.lang.String> propertyTypes)

getAssociationEntity

AssociationEntity getAssociationEntity(java.lang.String codingSchemeUri,
                                       java.lang.String version,
                                       java.lang.String entityCode,
                                       java.lang.String entityCodeNamespace)

getEntities

java.util.List<? extends Entity> getEntities(java.lang.String codingSchemeUri,
                                             java.lang.String version,
                                             int start,
                                             int pageSize)
Gets the entities.

Parameters:
codingSchemeUri - the coding scheme uri
version - the version
start - the start
pageSize - the page size
Returns:
the entities

getResolvedCodedNodeReference

ResolvedConceptReference getResolvedCodedNodeReference(java.lang.String codingSchemeUri,
                                                       java.lang.String version,
                                                       java.lang.String entityCode,
                                                       java.lang.String entityCodeNamespace,
                                                       boolean resolve,
                                                       java.util.List<java.lang.String> propertyNames,
                                                       java.util.List<java.lang.String> propertyTypes)

insertBatchEntities

void insertBatchEntities(java.lang.String codingSchemeUri,
                         java.lang.String version,
                         java.util.List<? extends Entity> entities)
Insert batch entities.

Parameters:
codingSchemeUri - the coding scheme uri
version - the version
entities - the entities

updateEntity

void updateEntity(java.lang.String codingSchemeUri,
                  java.lang.String version,
                  Entity entity)
                  throws LBException
Update entity.

Parameters:
codingSchemeName - the coding scheme name
version - the version
enityCode - the enity code
entityCodeNamespace - the entity code namespace
entity - the entity
Throws:
LBException

removeEntity

void removeEntity(java.lang.String codingSchemeUri,
                  java.lang.String version,
                  Entity entity)
                  throws LBException
Throws:
LBException

revise

void revise(java.lang.String codingSchemeUri,
            java.lang.String version,
            Entity revisedEntity)
            throws LBException
Throws:
LBException

resolveEntityByRevision

Entity resolveEntityByRevision(java.lang.String codingSchemeURI,
                               java.lang.String version,
                               java.lang.String entityCode,
                               java.lang.String entityCodeNamespace,
                               java.lang.String revisionId)
                               throws LBRevisionException
Throws:
LBRevisionException

resolveEntityByDate

Entity resolveEntityByDate(java.lang.String codingSchemeURI,
                           java.lang.String version,
                           java.lang.String entityCode,
                           java.lang.String entityCodeNamespace,
                           java.sql.Date date)
                           throws LBRevisionException
Throws:
LBRevisionException

getEntityDescription

EntityDescription getEntityDescription(java.lang.String codingSchemeURI,
                                       java.lang.String version,
                                       java.lang.String code,
                                       java.lang.String codeNamespace)

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.