Security.WebAppPctAccess

persistent class Security.WebAppPctAccess extends %Library.Persistent, %XML.Adaptor, %SYSTEM.Help

SQL Table Name: Security.WebAppPctAccess

This class defines the CSP-Based Web Application access for % classes.

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access.

Method Inventory

Create()
Delete()
Exists()
Export()
Get()
Import()
Modify()

Properties

property AllowAccess as Security.Datatype.BooleanYN [ InitialExpression = 1 ];

Allow access.
0 - Don't allow access to the class/Package.
1 - Allow access to the class/Package.

Property methods: AllowAccessDisplayToLogical(), AllowAccessGet(), AllowAccessGetStored(), AllowAccessIsValid(), AllowAccessLogicalToDisplay(), AllowAccessLogicalToOdbc(), AllowAccessLogicalToXSD(), AllowAccessNormalize(), AllowAccessOdbcToLogical(), AllowAccessSet(), AllowAccessXSDToLogical()

property AllowType as %String (MAXLEN = 16, MINLEN = 1) [ Required ];

Allowed type.
Allow typr must be one of the following:
AllowClass - Allow or disallow the application to call the class defined in the Class property.
AllowPrefix - Allow or disallow the application to call the a class which has the prefix defined in the class property.

Property methods: AllowTypeDisplayToLogical(), AllowTypeGet(), AllowTypeGetStored(), AllowTypeIsValid(), AllowTypeLogicalToDisplay(), AllowTypeLogicalToOdbc(), AllowTypeNormalize(), AllowTypeSet()

property Class as %String (MAXLEN = 256) [ Required ];

Classname or package the application is allowed access to.

Property methods: ClassDisplayToLogical(), ClassGet(), ClassGetStored(), ClassIsValid(), ClassLogicalToDisplay(), ClassLogicalToOdbc(), ClassNormalize(), ClassSet()

property Name as %String (MAXLEN = 64, MINLEN = 1);

Name of the application defined in Security.Applications.

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

Methods

classmethod Create(Name As %String, AllowType As %String, Class, ByRef Properties As %String) as %Status

Create an WebAppPctAccess.
Create an WebAppPctAccess in the Security database.
Parameters:
Name - Application name as defined in Security.Applications. If the value is "all-applications" the entry is defined for all defined applications.
AllowType - AllowClass or AllowPrefix
Class - Class or package name
Properties("AllowAccess") - 0 don't allow access to this class, 1 allow access

classmethod Delete(Name As %String, AllowType As %String, Class As %String) as %Status

Delete an WebAppPctAccess.
This method will delete an WebAppPctAccess from the Security database.
Parameters:
See the Create method for a description of the parameters

classmethod Exists(Name As %String = "", AllowType As %String = "", Class As %String = "", ByRef WebAppPctAccess As %ObjectHandle, ByRef Status As %Status) as %Boolean

WebAppPctAccess exists.
This method checks for the existence of an WebAppPctAccess in the Security database.
Parameters:
Name - Application name as defined in Security.Applications. If the value is "all-applications" the entry is defined for all defined applications.
AllowType - AllowClass or AllowPrefix
Class - Class or package name
Return values:
If Value of the method = 0 (WebAppPctAccess does not exist, or some error occured)
WebAppPctAccess = Null
Status = WebAppPctAccess does not exist, or other error message

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

classmethod Export(FileName As %String = "WebAppPctAccessExport.xml", ByRef NumExported As %Integer, Names As %String = "*", AllowTypes As %String = "*", Classes As %String = "*") as %Status

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

classmethod Get(Name As %String = "", AllowType As %String = "", Class As %String = "", ByRef Properties As %String) as %Status

Get an WebAppPctAccess properties.
Gets an WebAppPctAccess properties from the Security database.
Parameters:
Name - Application name as defined in Security.Applications. If the value is "all-applications" the entry is defined for all defined applications.
AllowType - AllowClass or AllowPrefix
Class - Class or package name
Return values:
Properties - Array of properties
Properties("AllowAccess") - 0 don't allow access to this class, 1 allow access

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

Import WebAppPctAccess records from an xml file.
Parameters:
FileName - Filename to import WebAppPctAccess 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 = "", AllowType As %String = "", Class As %String = "", ByRef Properties As %String) as %Status

Modify an WebAppPctAccess's properties.
Modifies an WebAppPctAccess's properties from the Security database.
Parameters:
Name - Application name as defined in Security.Applications. If the value is "all-applications" the entry is defined for all defined applications.
AllowType - AllowClass or AllowPrefix
Class - Class or package name
Return values:
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(Names As %String, AllowTypes As %String, Classes As %String, Filter As %String)

Selects Name As %String, AllowType As %String, Class As %String, AllowAccess As %String, System As %String, SystemInternal

Return list of WebAppPctAccess.
WebAppPctAccessources - Comma separated list of Names, "*" = All
WebAppPctAccessTypes - Comma separated list of AllowTypes, "*" = All
WebAppPctAccess - Comma separated list of Class/package names, "*" = All
Note: This query may change in future versions

Indexes

index (NameAllowTypeClassIndex on NameLowerCase,AllowType,Class) [IdKey, Type = key, Unique];

Index methods: NameAllowTypeClassIndexCheck(), NameAllowTypeClassIndexDelete(), NameAllowTypeClassIndexExists(), NameAllowTypeClassIndexOpen(), NameAllowTypeClassIndexSQLCheckUnique(), NameAllowTypeClassIndexSQLExists(), NameAllowTypeClassIndexSQLFindPKeyByConstraint(), NameAllowTypeClassIndexSQLFindRowIDByConstraint()