Elexis API documentation
Version 2.1.6 as of December 11 2011

ch.elexis.core.data
Interface IXid

All Known Implementing Classes:
Xid

public interface IXid

An IXid is an external identifier for an Object

Author:
gerry

Field Summary
static int ASSIGNMENT_GLOBAL
          Quality value for an ID that can be used as global identifier
static int ASSIGNMENT_LOCAL
          Quality value for an ID that is valid only in the context of the issuing program
static int ASSIGNMENT_REGIONAL
          Quality value for an ID that is valid within a geographic or politic context (e.g. a nationally assigned ID)
static java.lang.String DOMAIN_AHV
           
static java.lang.String DOMAIN_AUSTRIAN_PASSPORT
           
static java.lang.String DOMAIN_EAN
           
static java.lang.String DOMAIN_ELEXIS
           
static java.lang.String DOMAIN_GERMAN_PASSPORT
           
static java.lang.String DOMAIN_OID
           
static java.lang.String DOMAIN_SWISS_PASSPORT
           
static java.lang.String FLD_DOMAIN
           
static java.lang.String FLD_DOMAIN_ID
           
static java.lang.String FLD_OBJECT
           
static java.lang.String ID_IN_DOMAIN
           
static java.lang.String QUALITY
           
static int QUALITY_GUID
          Marker that the ID is a GUID (that is, guaranteed to exist only once through time and space)
static java.lang.String TYPE
           
 
Method Summary
 java.lang.String getDomain()
          get the Domain this Xid is from
 java.lang.String getDomainId()
          get the id of this Xid in its domain
 java.lang.String getId()
           
 java.lang.String getLabel()
           
 IPersistentObject getObject()
          Get the object that is identified with this XID
 int getQuality()
          Get the quality of this xid
 boolean isGUID()
          Tell whether this XID is a GUID
 

Field Detail

QUALITY

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

ID_IN_DOMAIN

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

TYPE

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

ASSIGNMENT_LOCAL

static final int ASSIGNMENT_LOCAL
Quality value for an ID that is valid only in the context of the issuing program

See Also:
Constant Field Values

ASSIGNMENT_REGIONAL

static final int ASSIGNMENT_REGIONAL
Quality value for an ID that is valid within a geographic or politic context (e.g. a nationally assigned ID)

See Also:
Constant Field Values

ASSIGNMENT_GLOBAL

static final int ASSIGNMENT_GLOBAL
Quality value for an ID that can be used as global identifier

See Also:
Constant Field Values

QUALITY_GUID

static final int QUALITY_GUID
Marker that the ID is a GUID (that is, guaranteed to exist only once through time and space)

See Also:
Constant Field Values

DOMAIN_ELEXIS

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

DOMAIN_AHV

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

DOMAIN_SWISS_PASSPORT

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

DOMAIN_AUSTRIAN_PASSPORT

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

DOMAIN_GERMAN_PASSPORT

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

DOMAIN_EAN

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

DOMAIN_OID

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

FLD_OBJECT

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

FLD_DOMAIN_ID

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

FLD_DOMAIN

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

getQuality

int getQuality()
Get the quality of this xid

Returns:
the quality

isGUID

boolean isGUID()
Tell whether this XID is a GUID

Returns:
true if so.

getDomain

java.lang.String getDomain()
get the Domain this Xid is from

Returns:

getDomainId

java.lang.String getDomainId()
get the id of this Xid in its domain

Returns:

getObject

IPersistentObject getObject()
Get the object that is identified with this XID

Returns:
the object or null if it could not be restored.

getLabel

java.lang.String getLabel()

getId

java.lang.String getId()

Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis