Elexis API documentation
Version 2.1.6 as of December 11 2011

ch.elexis.core.data
Interface IPartner

All Superinterfaces:
IPersistentObject, ISelectable
All Known Subinterfaces:
ICreditor, ICustomer, IDebtor, IPerson
All Known Implementing Classes:
Anwender, Kontakt, Labor, Mandant, Organisation, Patient, Person, Rechnungssteller, TransienterKontakt, TransienterPatient

public interface IPartner
extends IPersistentObject

An IPartner is just anybody or anything that contacts us

Author:
gerry

Field Summary
static java.lang.String FLD_NAME1
           
static java.lang.String FLD_NAME2
           
static java.lang.String FLD_NAME3
           
static int TYPE_ADMIN
          This partner is an admin of this system
static int TYPE_CLIENT
          This partner is a client/patient etc.
static int TYPE_MANAGER
          This partner is a manager (- sub-admin-) of this system
static int TYPE_MANDATOR
          This partner is a mandator for this system
static int TYPE_ORGANIZATION
          This partner is an organization
static int TYPE_PERSON
          This partner is a person
static int TYPE_USER
          This partner is a user of this system
 
Fields inherited from interface ch.elexis.core.data.IPersistentObject
DELETED, FLD_DATE, FLD_DELETED, FLD_EXTINFO, FLD_ID, FLD_LASTUPDATE, MATCH_AUTO, MATCH_CONTAINS, MATCH_EXACT, MATCH_REGEXP, MATCH_START, STATE_EXISTING, STATE_INEXISTENT, STATE_INVALID_ID
 
Method Summary
 ContactInfo getContactInfo(java.lang.String type)
          Get the ContactInfo of a given type
 ContactInfo[] getContactInfos()
          Retrieve all ContactInfos linked to this partner
 java.lang.String getContactSalutation()
          Retrieve the preferred salutation for this partner
 int getPartnerRoles()
          get the role info of this partner
 boolean hasRole(int role)
          Ask whether this partner has a given role
 void setPartnerRoles(int roles)
          set the role info of this parner
 
Methods inherited from interface ch.elexis.core.data.IPersistentObject
addChangeListener, addSticker, addXid, exists, get, get, getId, getInt, getLabel, getLastUpdate, getMap, getSticker, getStickers, getXid, getXid, getXids, isAvailable, isDeleted, isDragOK, isMatching, isMatching, isMatching, isMatching, isValid, removeChangeListener, removeSticker, set, set, setInt, setMap, state, storeToString
 

Field Detail

FLD_NAME1

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

FLD_NAME2

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

FLD_NAME3

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

TYPE_PERSON

static final int TYPE_PERSON
This partner is a person

See Also:
Constant Field Values

TYPE_ORGANIZATION

static final int TYPE_ORGANIZATION
This partner is an organization

See Also:
Constant Field Values

TYPE_CLIENT

static final int TYPE_CLIENT
This partner is a client/patient etc.

See Also:
Constant Field Values

TYPE_USER

static final int TYPE_USER
This partner is a user of this system

See Also:
Constant Field Values

TYPE_MANDATOR

static final int TYPE_MANDATOR
This partner is a mandator for this system

See Also:
Constant Field Values

TYPE_MANAGER

static final int TYPE_MANAGER
This partner is a manager (- sub-admin-) of this system

See Also:
Constant Field Values

TYPE_ADMIN

static final int TYPE_ADMIN
This partner is an admin of this system

See Also:
Constant Field Values
Method Detail

getPartnerRoles

int getPartnerRoles()
get the role info of this partner

Returns:
an integer consisting of OR'ed roles (TYPE_PERSON,TYPE_ADMIN and so on)

setPartnerRoles

void setPartnerRoles(int roles)
set the role info of this parner

Parameters:
roles - an integer consisting of OR'ed role values

hasRole

boolean hasRole(int role)
Ask whether this partner has a given role

Parameters:
role - a role value
Returns:
true if the partner has this role

getContactSalutation

java.lang.String getContactSalutation()
Retrieve the preferred salutation for this partner

Returns:
a String with the salutation

getContactInfos

ContactInfo[] getContactInfos()
Retrieve all ContactInfos linked to this partner

Returns:
a possibly empty array of ContactInfos's
See Also:
ContactInfo

getContactInfo

ContactInfo getContactInfo(java.lang.String type)
Get the ContactInfo of a given type

Parameters:
type - type to retrieve, e.g. CITYPE_HOME or CITYPE_WORK. If null, the default will be retrieved
Returns:
a ContactInfo or null if the Partner has no ContactInfo's at all

Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis