TOPICA Basic Class OrgUnit |
[This is preliminary documentation and is subject to change.]
The OrgUnit class models organizational unit.
Property | Type | Description |
---|---|---|
Type | String | The type part of the key |
Code | String | The code part of the key |
Name | String | The name of the organizational unit |
FullName | String | For each type of organizational units it is possible to specify, that the name of a parent organizational unit should be prefixed to the name of the curent organizatinal unit in order to return the full name. For esample, many hospitals may have wards / departments with the same name, e.g. "Intensive Care Unit". In this case it is useful to include the name of the hospital in the full name, so that the full name will be for example "Hospital X, Intensive Care Unit" or "Hospital Y, Intensive Care Unit". |
TypeCodeName | String | Concatenation of properties Type, Code, and Name |
TypeCodeFullName | String | Concatenation of properties Type, Code, and FullName |
Key | String | Concatenation of properties Type and Code, separated by ":". |
Alias | String | Alternative description of the organizational unit. |
ShortName | String | Short name. |
IsInstitution | Boolean | Insititution status. |
Accreditation | Boolean | "Active" in the accreditation sub-system. |
Location | String | Address: location |
Road | String | Address: road name |
HouseNum | String | Address: house number |
ZipNum | Integer | Zip number |
ZipText | String | Zip text from zip table, obtained by look-up using ZipNum |
Phone | String | Telephone number |
Fax | String | Fax number |
String | E-mail address | |
EANIdentifier | Long | EAN identifier |
Address | String | Full addresse constructed from properties Location, Road, HouseNum, ZipNum. |
OrgUnitType | The OrgUnitType object describing this OrgUnit's type. | |
Parent, ParentOrgUnit | The OrgUnit object describing this OrgUnit's parent OrgUnit. | |
AncestorDifferentType | The OrgUnit object "upwards" in the hierarchy, that has a type different form the type of the current OrgUnit. Useful when some types may be self-referenceing. For example if a type "department" may have sub-units of type "department". Using AncestorDifferentType property will run through ancestors until an OrgUnit with a type different from "department" is found, and return this ancestor (this ancestor may be for examaple of type "hospital"). | |
SubOrgUnits | All the (immediate) sub-units. |