Class %SYS.PhoneProviders

persistent class %SYS.PhoneProviders extends %Persistent, %XML.Adaptor, %SYSTEM.Help

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	2	11	1	1

Summary

Properties
Name	SMSGateway

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%BMEBuilt
%BuildIndices	%CheckUnique	%ClassIsLatestVersion	%ClassName
%ComposeOid	%ConstructClone	%Delete	%DeleteExtent
%DeleteId	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Exists	%ExistsId	%Extends	%GUID
%GUIDSet	%GetLock	%GetParameter	%GetSwizzleObject
%Id	%InsertBatch	%IsA	%IsModified
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDetermineClass	%Open
%OpenId	%OriginalNamespace	%PackageName	%PhysicalAddress
%PurgeIndices	%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict
%RollBack	%Save	%SaveDirect	%SaveIndices
%SerializeObject	%SetModified	%SortBegin	%SortEnd
%SyncObjectIn	%SyncTransport	%UnlockExtent	%UnlockId
%ValidateObject	Exists	Export	GetProperties
Help	Import	Modify	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType

Properties

• property Name as %String [ Required ];

Business name

• property SMSGateway as %String [ Required ];

DNS name of SMTP-to-SMS gateway

Methods

• classmethod Exists(Name As %String, ByRef PhoneProvider As %ObjectHandle, ByRef Status As %Status) as %Boolean

PhoneProvider exists.
This method checks for the existence of a PhoneProvider in the security database.
Parameters:
Name - Name of the PhoneProvider to check existence of
Return values:
If Value of the method = 0 (PhoneProvider does not exist, or some error occured)
PhoneProvider = Null
Status = PhoneProvider "x" does not exist, or other error message

If Value of the method = 1 (PhoneProvider exists)
PhoneProvider = Object handle to PhoneProvider
Status = $$$OK

• classmethod Export(FileName As %String = "PhoneProvidersExport.xml", ByRef NumExported As %Integer, PhoneProviders As %String = "*") as %Status

This method exports PhoneProvider records to a file in xml format.
Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
PhoneProviders - Comma separated list of PhoneProviders to export, "*" = All

• classmethod GetProperties(PhoneProvider As %ObjectHandle, ByRef Properties As %String) as %Status

Get a PhoneProvider's properties.
Gets a PhoneProviders's properties from the security database.
Parameters:
PhoneProvider - Object handle to a PhoneProviders record
Return values:
Properties - See the Get method for more information on properties returned

• classmethod Import(FileName As %String = "PhoneProvidersExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status

Import PhoneProvider records from an xml file.
Parameters:
FileName - Filename to import PhoneProvider records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

• classmethod Modify(Name As %String, ByRef Properties As %String) as %Status

Modify a PhoneProvider.
Modify an existing PhoneProvider's properties in the security database.
Parameters:
Name - Name of the PhoneProvider to modify
Properties - Array of properties to modify.
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified.

Queries

• query List()

Selects Name As %String, SMSGateway As %String

SQL Query :
SELECT Name,SMSGateway FROM PhoneProviders
ORDER BY Name

Indices

• index (NameIndex on Name) [IdKey];


[BASEXML] > [%SYS] > [PhoneProviders]		Private Storage