Properties (Including Private)Copy link to this section
property ClientName as %CacheString ;
Copy link to this section
ClientName
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
Copy link to this section
True if this query is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString ;
Copy link to this section
Specifies a description of the query.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Final as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies that subclasses cannot override the definition of the query.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
Specifies the list of arguments passed to the Execute method. Each argument is of the format [&|*]<name>[:<type>][=<default>] where & means pass-by-reference and * means output-only.
Property methods: FormalSpecGet(), FormalSpecIsValid(), FormalSpecSet()
property Internal as %Boolean [ InitialExpression = 0 ];
Copy link to this section
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
The name of the query.
Property methods: NameGet(), NameIsValid(), NameSet()
property NotInheritable as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Deprecated
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Parameters as array of %CacheString ;
Copy link to this section
Parameter
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Private as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Deprecated.
Property methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize(), PrivateSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
Copy link to this section
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SoapBindingStyle as %CacheString ;
Copy link to this section
Specifies what type of SOAP invocation is used for a web method. This keyword is ignored for non-web methods.
Property methods: SoapBindingStyleGet(), SoapBindingStyleIsValid(), SoapBindingStyleSet()
property SoapBodyUse as %CacheString ;
Copy link to this section
Specifies what kind of SOAP encoding is used for the inputs and outputs of a web method. This keyword is ignored for non-web methods.
Property methods: SoapBodyUseGet(), SoapBodyUseIsValid(), SoapBodyUseSet()
property SoapNameSpace as %CacheString ;
Copy link to this section
SoapNameSpace
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsValid(), SoapNameSpaceSet()
If this query is projected as an SQL stored procedure, then this name is used as the name of the stored procedure.
Property methods: SqlNameGet(), SqlNameIsValid(), SqlNameSet()
property SqlProc as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies that the query can be invoked as an SQL stored procedure.
Property methods: SqlProcDisplayToLogical(), SqlProcGet(), SqlProcIsValid(), SqlProcLogicalToDisplay(), SqlProcNormalize(), SqlProcSet()
property SqlQuery as %CacheString ;
Copy link to this section
Specifies an SQL statement to be used for an SQL-based query.
Property methods: SqlQueryGet(), SqlQueryIsValid(), SqlQuerySet()
property SqlView as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies whether to project this query as an SQL View.
Property methods: SqlViewDisplayToLogical(), SqlViewGet(), SqlViewIsValid(), SqlViewLogicalToDisplay(), SqlViewNameGet(), SqlViewNameIsValid(), SqlViewNameSet(), SqlViewNormalize(), SqlViewSet()
property SqlViewName as %CacheString ;
Copy link to this section
Specifies an SQL alias for the view projected from this query.
Property methods: SqlViewNameGet(), SqlViewNameIsValid(), SqlViewNameSet()
Specifies the Query class used to provide the implementation of the query interface.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
property WebMethod as %Boolean [ InitialExpression = 0 ];
Copy link to this section
description=Specifies that this query can be invoked using the SOAP protocol.
Property methods: WebMethodDisplayToLogical(), WebMethodGet(), WebMethodIsValid(), WebMethodLogicalToDisplay(), WebMethodNormalize(), WebMethodSet()
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()
Methods (Including Private)Copy link to this section
Inherited description: Checks to see if the object identified by the OID
oid exists in the extent.
Returns %Boolean TRUE if it exists, FALSE if it does not.
private method %LoadData(id As %String ) as %Status
Copy link to this section
Inherited description: %LoadData() - loads an object from storage. This method is
implemented by the storage class.
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
%Library.CacheStorage or
%Library.CacheSQLStorage .
private method %OnNew(name As %String ) as %Status
Copy link to this section
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
Copy link to this section
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.
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
%Library.CacheStorage or
%Library.CacheSQLStorage .
classmethod SoapBindingStyleIsValid(val As %String ) as %Status
Copy link to this section
classmethod SoapBodyUseIsValid(val As %String ) as %Status
Copy link to this section