%pkg.isc.rest.openAPI.model.super
persistent class %pkg.isc.rest.openAPI.model.super extends %Library.Persistent, %pkg.isc.rest.openAPI.customizableJSONAdaptor
SQL Table Name: %pkg_isc_rest_openAPI_model.super
Model Super-class, provides utility/verification methodsMethod Inventory
- AllowsExtendedProperties()
- Delete()
- DeleteExtent()
- GetAllFromSpec()
- GetContainingObject()
- GetDefinedType()
- GetReference()
- GetSaveableInstance()
- GetUnsaveableInstance()
- IsReference()
- JSONExportOverride()
- KillExtent()
- OnFail()
- ResolveReference()
- Validate()
- ValidateComponent()
- ValidateComponents()
Parameters
parameter %JSONINCLUDEID = 0;
parameter DEFAULTGLOBAL = ^pkg.isc.rest.oas.model.super;
Inherited description:
The location types are:
If a persistent class uses %Storage.Persistent then the DEFAULTGLOBAL parameter is used as the default global root for the values of the storage keywords COUNTERLOCATION, DATALOCATION, IDLOCATION, INDEXLOCATION and STREAMLOCATION in the active storage definition. DEFAULTGLOBAL is only used to generate location keyword values that are not already defined. The location value is constructed by adding a location type to the end of DEFAULTGLOBAL. For example, if DEFAULTGLOBAL = "^GL.Account" the compiler will generate DATALOCATION = ^GL.AccountD.
If USEEXTENTSET is true, then DEFAULTGLOBAL is used as the default extent location.
The location types are:
| Location | Type |
|---|---|
| COUNTERLOCATION | C |
| DATALOCATION | D |
| IDLOCATION | D |
| INDEXLOCATION | I |
| STREAMLOCATION | S |
Methods
method AllowsExtendedProperties() as %Boolean
@Override: Whether or not this object allows extended properties
method Delete() as %Status
final classmethod DeleteExtent()
classmethod GetAllFromSpec(super As %pkg.isc.rest.openAPI.model.super, className) as %ListOfObjects
Returns a list of all instances of the given class found within the specified OpenAPI specification
method GetContainingObject(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI) as %pkg.isc.rest.openAPI.model.super
Gets the objct containing $This within the specified OpenAPI specification
method GetDefinedType(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI)
Gets the defined (property) type of $This within the specified OpenAPI specification
classmethod GetReference(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI, super As %pkg.isc.rest.openAPI.model.super, internal=0) as %String
Gets a reference string for the super object within the specified OpenAPI specification (returns the input string on failure)
method GetSaveableInstance(expect="") as %pkg.isc.rest.openAPI.model.super
method GetUnsaveableInstance() as %pkg.isc.rest.openAPI.model.super
method IsReference() as %Boolean
Returns true if the current object is a reference.
@Special: Override the JSONExport behavior defined by %pkg.isc.json, in order to return a JSON representation of
..? or ..Reference instead of this object, for instances of ?OrReference classes
final classmethod KillExtent()
method OnFail(fullSpecification, debug, description, property="")
Report a validation failure
method ResolveReference(reference As %String, fullSpecification As %pkg.isc.rest.openAPI.model.openAPI, internal=0) as %pkg.isc.rest.openAPI.model.super
Resolves a reference string to an object within the specified OpenAPI specification (returns the empty-string on failure)
method Validate(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI, debug=0) as %Boolean
Object-specific validation logic within a given OpenAPI Specification (use ..ValidateComponent() for full validation)
method ValidateComponent(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI, debug=0) as %Boolean
Validates a component within a specified OpenAPI specification (override ..Validate() in place of this in sub-classes!)
method ValidateComponents(fullSpecification As %pkg.isc.rest.openAPI.model.openAPI, debug=0)
Validates the sub-components of this object
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %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()
- %IsNull()
- %JSONExport()
- %JSONExportToString()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: Storage (%pkg.isc.rest.openAPI.model.super)
^pkg.isc.rest.oas.model.superD(ID) |
= | %%CLASSNAME
|