Specifies that this is an abstract method. An abstract method has no implementation and has no executable code generated for it. Abstract methods exist solely for the purpose of defining a method signature or interface that can be overridden and implemented within one or more subclasses.
Specifies that the method is a class method. Instance methods can only be invoked via an instantiated object while class methods can be directly invoked without an object instance.
Specifies how a given method is implemented: as a routine call, lines of code to be compiled, an expression, or a method that will generate the resulting method or object.
Specifies the list of arguments. Each argument is of the format [&|*]<name>[:<type>][=<default>] where & means pass-by-reference and * means output-only.
The code that is executed when the method is invoked. In the case of an expression method, this is an expression. In the case of a call method, this is the name of an ObjectScript routine to call.
If true and in a datatype method, this prevents the * Set %val=..prop Set $this="" * that is added to the property method so you can override things like the Get/Set methods.
Lets you specify the HTTP SOAP action that must be used when invoking this web service method as a web method. For SOAP 1.1, the SOAP action is obtained from the SOAPAction HTTP header. For SOAP 1.2, it is obtained from the Content-Type HTTP header.
This keyword will reflects the expected element name for top element of the SOAP body in the SOAP request. This element is needed to distinguish between multiple requests which have the same SoapAction but different top level body elements.
If 'procedure' then this is equivalent to SqlProc keyword and means class method can be called as an SQL procedure. If 'function' then this class method can be called as an SQL function.
private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]
Inherited description: This method is normally generated by the storage class for persistent classes using
%Storage.Persistent or %Storage.SQL. Persistent
classes using some other storage class, such as %Library.CustomStorage must override this
method.
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type
of lock obtained is determined by shared. This method is normally generated by
the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
private method %OnNew(name As %String) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to
provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call.
When customizing this method, override the arguments with whatever variables and types you expect to receive from %New().
For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status
If instead of returning a %Status code this returns an oref and this oref is a subclass of the current
class then this oref will be the one returned to the caller of %New method.
private method %SaveData(id As %String) as %Status [ Language = objectscript ]
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential
integrity constraints, and maintains index structures. This method is
implemented by the storage class.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: Release an exclusive or shared lock on the object identified by id. The type
of lock released is determined by shared. If this method is not overridden
then the default implementation returns an error. This method is normally generated by
the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
method AbstractIsDefined() as %Boolean [ Language = objectscript ]
method AbstractReset() [ Language = objectscript ]
method AbstractSet(value As %String = "") as %Status [ Language = objectscript ]
method ClassMethodIsDefined() as %Boolean [ Language = objectscript ]
method ClassMethodReset() [ Language = objectscript ]
method ClassMethodSet(value As %String = "") as %Status [ Language = objectscript ]
method ClientMethodIsDefined() as %Boolean [ Language = objectscript ]
method ClientMethodReset() [ Language = objectscript ]
method ClientMethodSet(value As %String = "") as %Status [ Language = objectscript ]
method ClientNameIsDefined() as %Boolean [ Language = objectscript ]
method ClientNameReset() [ Language = objectscript ]
method ClientNameSet(value As %String = "") as %Status [ Language = objectscript ]
method CodeModeIsDefined() as %Boolean [ Language = objectscript ]
method CodeModeReset() [ Language = objectscript ]
method CodeModeSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method ExternalProcNameIsDefined() as %Boolean [ Language = objectscript ]
method ExternalProcNameReset() [ Language = objectscript ]
method ExternalProcNameSet(value As %String = "") as %Status [ Language = objectscript ]
method FinalIsDefined() as %Boolean [ Language = objectscript ]
method FinalReset() [ Language = objectscript ]
method FinalSet(value As %String = "") as %Status [ Language = objectscript ]
method ForceGenerateIsDefined() as %Boolean [ Language = objectscript ]
method ForceGenerateReset() [ Language = objectscript ]
method ForceGenerateSet(value As %String = "") as %Status [ Language = objectscript ]
method FormalSpecIsDefined() as %Boolean [ Language = objectscript ]
method FormalSpecReset() [ Language = objectscript ]
method FormalSpecSet(value As %String = "") as %Status [ Language = objectscript ]
method GenerateAfterIsDefined() as %Boolean [ Language = objectscript ]
method GenerateAfterReset() [ Language = objectscript ]
method GenerateAfterSet(value As %String = "") as %Status [ Language = objectscript ]
method HashIsDefined() as %Boolean [ Language = objectscript ]
method HashReset() [ Language = objectscript ]
method HashSet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method LanguageIsDefined() as %Boolean [ Language = objectscript ]
method LanguageReset() [ Language = objectscript ]
method LanguageSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method NoContextIsDefined() as %Boolean [ Language = objectscript ]
method NoContextReset() [ Language = objectscript ]
method NoContextSet(value As %String = "") as %Status [ Language = objectscript ]
method NotForPropertyIsDefined() as %Boolean [ Language = objectscript ]
method NotForPropertyReset() [ Language = objectscript ]
method NotForPropertySet(value As %String = "") as %Status [ Language = objectscript ]
method NotInheritableIsDefined() as %Boolean [ Language = objectscript ]
method NotInheritableReset() [ Language = objectscript ]
method NotInheritableSet(value As %String = "") as %Status [ Language = objectscript ]
method PlaceAfterIsDefined() as %Boolean [ Language = objectscript ]
method PlaceAfterReset() [ Language = objectscript ]
method PlaceAfterSet(value As %String = "") as %Status [ Language = objectscript ]
method PrivateIsDefined() as %Boolean [ Language = objectscript ]
method PrivateReset() [ Language = objectscript ]
method PrivateSet(value As %String = "") as %Status [ Language = objectscript ]
method ProcedureBlockIsDefined() as %Boolean [ Language = objectscript ]
method ProcedureBlockReset() [ Language = objectscript ]
method ProcedureBlockSet(value As %String = "") as %Status [ Language = objectscript ]
method PublicListIsDefined() as %Boolean [ Language = objectscript ]
method PublicListReset() [ Language = objectscript ]
method PublicListSet(value As %String = "") as %Status [ Language = objectscript ]
method RequiresIsDefined() as %Boolean [ Language = objectscript ]
method RequiresReset() [ Language = objectscript ]
method RequiresSet(value As %String = "") as %Status [ Language = objectscript ]
method ReturnResultsetsIsDefined() as %Boolean [ Language = objectscript ]
method ReturnResultsetsReset() [ Language = objectscript ]
method ReturnResultsetsSet(value As %String = "") as %Status [ Language = objectscript ]
method ReturnTypeIsDefined() as %Boolean [ Language = objectscript ]
method ReturnTypeParamsIsDefined() as %Boolean [ Language = objectscript ]
method ReturnTypeParamsReset() [ Language = objectscript ]
method ReturnTypeParamsSet(value As %String = "") as %Status [ Language = objectscript ]
method ReturnTypeReset() [ Language = objectscript ]
method ReturnTypeSet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method ServerOnlyIsDefined() as %Boolean [ Language = objectscript ]
method ServerOnlyReset() [ Language = objectscript ]
method ServerOnlySet(value As %String = "") as %Status [ Language = objectscript ]
method SoapActionIsDefined() as %Boolean [ Language = objectscript ]
method SoapActionReset() [ Language = objectscript ]
method SoapActionSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapBindingStyleIsDefined() as %Boolean [ Language = objectscript ]
method SoapBindingStyleReset() [ Language = objectscript ]
method SoapBindingStyleSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapBodyUseIsDefined() as %Boolean [ Language = objectscript ]
method SoapBodyUseReset() [ Language = objectscript ]
method SoapBodyUseSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapMessageNameIsDefined() as %Boolean [ Language = objectscript ]
method SoapMessageNameReset() [ Language = objectscript ]
method SoapMessageNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapNameSpaceIsDefined() as %Boolean [ Language = objectscript ]
method SoapNameSpaceReset() [ Language = objectscript ]
method SoapNameSpaceSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapRequestMessageIsDefined() as %Boolean [ Language = objectscript ]
method SoapRequestMessageReset() [ Language = objectscript ]
method SoapRequestMessageSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapTypeNameSpaceIsDefined() as %Boolean [ Language = objectscript ]
method SoapTypeNameSpaceReset() [ Language = objectscript ]
method SoapTypeNameSpaceSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlNameReset() [ Language = objectscript ]
method SqlNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlProcIsDefined() as %Boolean [ Language = objectscript ]
method SqlProcReset() [ Language = objectscript ]
method SqlProcSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRoutineIsDefined() as %Boolean [ Language = objectscript ]
method SqlRoutineReset() [ Language = objectscript ]
method SqlRoutineSet(value As %String = "") as %Status [ Language = objectscript ]
method WebMethodIsDefined() as %Boolean [ Language = objectscript ]
method WebMethodReset() [ Language = objectscript ]
method WebMethodSet(value As %String = "") as %Status [ Language = objectscript ]
method ZenMethodIsDefined() as %Boolean [ Language = objectscript ]
method ZenMethodReset() [ Language = objectscript ]
method ZenMethodSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]
Indexes
index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()