Skip to main content

HS.Registry.Person.User.WebServices.Containers.User

persistent class HS.Registry.Person.User.WebServices.Containers.User extends %Library.Persistent, HS.Util.WebServices.ServiceStatus, HS.Util.WebServices.ListItem

SQL Table Name: HS_Registry_Person_User_WebServices_Containers.User

Property Inventory

Parameters

parameter %JSONENABLED = 1;
Overridden from %JSON.Adaptor.
Is set to 0 in other intermediate superclasses so must be 1 here.

Properties

property Active as %Boolean [ InitialExpression = 1 ];
Property methods: ActiveDisplayToLogical(), ActiveGet(), ActiveGetStored(), ActiveIsValid(), ActiveLogicalToDisplay(), ActiveLogicalToXSD(), ActiveNormalize(), ActiveSet(), ActiveXSDToLogical()
property AdditionalInfo as array of %String (MAXLEN = 1024);
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoDisplayToLogical(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetStored(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
deprecated property AssigningAuthority as %String);
No longer used
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityGetStored(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
property CacheUser as %Boolean [ InitialExpression = 0 ];
Property methods: CacheUserDisplayToLogical(), CacheUserGet(), CacheUserGetStored(), CacheUserIsValid(), CacheUserLogicalToDisplay(), CacheUserLogicalToXSD(), CacheUserNormalize(), CacheUserSet(), CacheUserXSDToLogical()
property City as %String (MAXLEN = 64);
Corresponds to Addresses.City in HS.Registry.Person.User.
Property methods: CityDisplayToLogical(), CityGet(), CityGetStored(), CityIsValid(), CityLogicalToDisplay(), CityLogicalToOdbc(), CityNormalize(), CitySet()
property Country as %String (MAXLEN = 64);
Corresponds to Addresses.Country in HS.Registry.Person.User.
Property methods: CountryDisplayToLogical(), CountryGet(), CountryGetStored(), CountryIsValid(), CountryLogicalToDisplay(), CountryLogicalToOdbc(), CountryNormalize(), CountrySet()
property Description as %String);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Email as list of HS.Types.Telecom;
Property methods: EmailBuildValueArray(), EmailCollectionToDisplay(), EmailCollectionToOdbc(), EmailDisplayToCollection(), EmailGet(), EmailGetObject(), EmailGetObjectId(), EmailGetStored(), EmailGetSwizzled(), EmailIsValid(), EmailOdbcToCollection(), EmailSet(), EmailSetObject(), EmailSetObjectId()
property EmailAddress as %String (MAXLEN = 500);
Property methods: EmailAddressDisplayToLogical(), EmailAddressGet(), EmailAddressGetStored(), EmailAddressIsValid(), EmailAddressLogicalToDisplay(), EmailAddressLogicalToOdbc(), EmailAddressNormalize(), EmailAddressSet()
property Fax as HS.Types.Telecom;
Property methods: FaxGet(), FaxGetObject(), FaxGetObjectId(), FaxGetStored(), FaxGetSwizzled(), FaxIsEmpty(), FaxIsValid(), FaxNewObject(), FaxSet(), FaxSetObject(), FaxSetObjectId(), FaxUnSwizzle()
property FirstName as HS.Types.PersonName.Given;
Property methods: FirstNameDisplayToLogical(), FirstNameGet(), FirstNameGetStored(), FirstNameIsValid(), FirstNameLogicalToDisplay(), FirstNameLogicalToOdbc(), FirstNameNormalize(), FirstNameSet()
property Identifiers as list of HS.Types.Identifier;
Property methods: IdentifiersBuildValueArray(), IdentifiersCollectionToDisplay(), IdentifiersCollectionToOdbc(), IdentifiersDisplayToCollection(), IdentifiersGet(), IdentifiersGetObject(), IdentifiersGetObjectId(), IdentifiersGetStored(), IdentifiersGetSwizzled(), IdentifiersIsValid(), IdentifiersOdbcToCollection(), IdentifiersSet(), IdentifiersSetObject(), IdentifiersSetObjectId()
property IgnoreProviderUpdates as %Boolean [ InitialExpression = 0 ];
Property methods: IgnoreProviderUpdatesDisplayToLogical(), IgnoreProviderUpdatesGet(), IgnoreProviderUpdatesGetStored(), IgnoreProviderUpdatesIsValid(), IgnoreProviderUpdatesLogicalToDisplay(), IgnoreProviderUpdatesLogicalToXSD(), IgnoreProviderUpdatesNormalize(), IgnoreProviderUpdatesSet(), IgnoreProviderUpdatesXSDToLogical()
property LastName as HS.Types.PersonName.Family;
Property methods: LastNameDisplayToLogical(), LastNameGet(), LastNameGetStored(), LastNameIsValid(), LastNameLogicalToDisplay(), LastNameLogicalToOdbc(), LastNameNormalize(), LastNameSet()
property Location as %String (MAXLEN = 256);
Property methods: LocationDisplayToLogical(), LocationGet(), LocationGetStored(), LocationIsValid(), LocationLogicalToDisplay(), LocationLogicalToOdbc(), LocationNormalize(), LocationSet()
property MessageRepository as %String (MAXLEN = 256);
Property methods: MessageRepositoryDisplayToLogical(), MessageRepositoryGet(), MessageRepositoryGetStored(), MessageRepositoryIsValid(), MessageRepositoryLogicalToDisplay(), MessageRepositoryLogicalToOdbc(), MessageRepositoryNormalize(), MessageRepositorySet()
property MiddleName as HS.Types.PersonName.Middle;
Property methods: MiddleNameDisplayToLogical(), MiddleNameGet(), MiddleNameGetStored(), MiddleNameIsValid(), MiddleNameLogicalToDisplay(), MiddleNameLogicalToOdbc(), MiddleNameNormalize(), MiddleNameSet()
property Mobile as HS.Types.Telecom;
Property methods: MobileGet(), MobileGetObject(), MobileGetObjectId(), MobileGetStored(), MobileGetSwizzled(), MobileIsEmpty(), MobileIsValid(), MobileNewObject(), MobileSet(), MobileSetObject(), MobileSetObjectId(), MobileUnSwizzle()
deprecated property Number as %String);
No longer used.
Property methods: NumberDisplayToLogical(), NumberGet(), NumberGetStored(), NumberIsValid(), NumberLogicalToDisplay(), NumberLogicalToOdbc(), NumberNormalize(), NumberSet()
property Organization as %Boolean [ InitialExpression = 0 ];
Support organization to differenciate from user type
Property methods: OrganizationDisplayToLogical(), OrganizationGet(), OrganizationGetStored(), OrganizationIsValid(), OrganizationLogicalToDisplay(), OrganizationLogicalToXSD(), OrganizationNormalize(), OrganizationSet(), OrganizationXSDToLogical()
property Pager as HS.Types.Telecom;
Property methods: PagerGet(), PagerGetObject(), PagerGetObjectId(), PagerGetStored(), PagerGetSwizzled(), PagerIsEmpty(), PagerIsValid(), PagerNewObject(), PagerSet(), PagerSetObject(), PagerSetObjectId(), PagerUnSwizzle()
property Phone as HS.Types.Telecom;
Property methods: PhoneGet(), PhoneGetObject(), PhoneGetObjectId(), PhoneGetStored(), PhoneGetSwizzled(), PhoneIsEmpty(), PhoneIsValid(), PhoneNewObject(), PhoneSet(), PhoneSetObject(), PhoneSetObjectId(), PhoneUnSwizzle()
property Proxies as array of %String (MAXLEN = 256);
Keys are full names so have the MAXLEN of Name.
Property methods: ProxiesBuildValueArray(), ProxiesCollectionToDisplay(), ProxiesCollectionToOdbc(), ProxiesDisplayToCollection(), ProxiesDisplayToLogical(), ProxiesGet(), ProxiesGetObject(), ProxiesGetObjectId(), ProxiesGetStored(), ProxiesGetSwizzled(), ProxiesIsValid(), ProxiesLogicalToDisplay(), ProxiesLogicalToOdbc(), ProxiesNormalize(), ProxiesOdbcToCollection(), ProxiesSet(), ProxiesSetObject(), ProxiesSetObjectId()
property Specialty as %String (MAXLEN = 256);
Property methods: SpecialtyDisplayToLogical(), SpecialtyGet(), SpecialtyGetStored(), SpecialtyIsValid(), SpecialtyLogicalToDisplay(), SpecialtyLogicalToOdbc(), SpecialtyNormalize(), SpecialtySet()
property State as %String (MAXLEN = 64);
Corresponds to Addresses.State in HS.Registry.Person.User.
Property methods: StateDisplayToLogical(), StateGet(), StateGetStored(), StateIsValid(), StateLogicalToDisplay(), StateLogicalToOdbc(), StateNormalize(), StateSet()
property Street as %String);
Corresponds to Addresses.StreetLine in HS.Registry.Person.User.
Property methods: StreetDisplayToLogical(), StreetGet(), StreetGetStored(), StreetIsValid(), StreetLogicalToDisplay(), StreetLogicalToOdbc(), StreetNormalize(), StreetSet()
property SubSpecialty as %String (MAXLEN = 256);
Property methods: SubSpecialtyDisplayToLogical(), SubSpecialtyGet(), SubSpecialtyGetStored(), SubSpecialtyIsValid(), SubSpecialtyLogicalToDisplay(), SubSpecialtyLogicalToOdbc(), SubSpecialtyNormalize(), SubSpecialtySet()
property Suffix as HS.Types.PersonName.Suffix;
Property methods: SuffixDisplayToLogical(), SuffixGet(), SuffixGetStored(), SuffixIsValid(), SuffixLogicalToDisplay(), SuffixLogicalToOdbc(), SuffixNormalize(), SuffixSet()
property Type as %String;
This property, when set through UI, will guarantee to have a value.
For backward compatibility, however, is not restricted as required here.
It gets set as default 'U' in AddEditUser() method of HS.Registry.Person.User.WebServices in certain cases.
See detail comments in AddEditUser()
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property UserID as %String (MAXLEN = 128);
Property methods: UserIDDisplayToLogical(), UserIDGet(), UserIDGetStored(), UserIDIsValid(), UserIDLogicalToDisplay(), UserIDLogicalToOdbc(), UserIDNormalize(), UserIDSet()
property Zip as %String (MAXLEN = 64);
Corresponds to Addresses.PostalCode in HS.Registry.Person.User.
Property methods: ZipDisplayToLogical(), ZipGet(), ZipGetStored(), ZipIsValid(), ZipLogicalToDisplay(), ZipLogicalToOdbc(), ZipNormalize(), ZipSet()

Indexes

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: Storage (HS.Registry.Person.User.WebServices.Containers.User)

^HS.Registry.Person.Us1585.UserD(ID,"AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Registry.Person.User.WebServices.Containers.User)

^HS.Registry.Person.Us1585.UserD(ID,"Proxies",n)
=
Proxies(n)

Storage Model: Storage (HS.Registry.Person.User.WebServices.Containers.User)

^HS.Registry.Person.Us1585.UserD(ID)
=
%%CLASSNAME
UserID
LastName
FirstName
%User
%Roles
%Gateway
MessageRepository
Street
City
State
Zip
Country
EmailAddress
Phone
Mobile
Fax
Pager
Active
CacheUser
Type
Identifiers
Number
AssigningAuthority
Specialty
SubSpecialty
Location
Email
AssociateProvider
Gender
ProviderTypes
Languages
Specialties
Services
MemberOf
Practices
ProviderID
Description
ID
MiddleName
Name
Status
Suffix
IgnoreProviderUpdates
Organization
FeedbackOpens in a new tab