dmaClass_QuerySearchableClass

Objects of this class designate a searchable class in a Document space. Objects of this class appear in the From Expression of queries and subqueries.

Class ID: dmaClass_QuerySearchableClass
Superclass: Query Node

Interfaces

Properties

Name	Impl. Required	System Gen'ed	Read-Only	Value Required	Type	Cardinality	Required Class
OIID	-	Yes	Yes	-	String	Scalar
Class Description	Yes	Yes	Yes	Yes	Object	Scalar	Class Description
This	-	Yes	Yes	Yes	Object	Scalar	Query Searchable Class
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Searchable Class Id	Yes	-	-	Yes	ID	Scalar
Searchable Class Occurrence	Yes	-	-	Yes	Integer32	Scalar
Include Subclasses Requested	-	-	-	Yes	Boolean	Scalar

Property Descriptions

• OIID {dmaProp_OIID}
Property Inherited from DMA

• Class Description {dmaProp_ClassDescription}
Property Inherited from DMA

• This {dmaProp_This}
Property Inherited from DMA

• Create Pending {dmaProp_CreatePending}
Property Inherited from DMA

• Update Pending {dmaProp_UpdatePending}
Property Inherited from DMA

• Delete Pending {dmaProp_DeletePending}
Property Inherited from DMA

• Searchable Class Id {dmaProp_SearchableClassId}

Specifies the searchable class. The value may be any one of the identifiers for the desired class.

• Searchable Class Occurrence {dmaProp_SearchableClassOccurrence}

This is the occurrence number of the searchable class in the current query.

In each query, the searchable class occurrences are assigned non negative integers by the client. These integers are unique in the context of the current query. This is necessary because the same searchable class can occur more than once in the From Expression’s of the query. References to properties in the query are tied to a particular searchable class occurrence.

• Include Subclasses Requested {dmaProp_IncludeSubclassesRequested}

This property controls whether a search includes subclasses of the class specified.

If the value of this property is not set or is set to FALSE, then the only class searched is the class whose Id is the value of dmaProp_SearchableClassId.

If the value of this property is TRUE, then the class whose Id is the value of dmaProp_SearchableClassId and all subclasses of that class are searched, as long as the document space supports this feature. The dmaProp_HasIncludeSubclasses property of the Class Description object indicates whether this subclass search feature is supported by a particular class. Note that if dmaProp_SearchableClassId is equal to dmaClass_DocVersion, and the value of this property and dmaProp_HasIncludeSubclasses of the Class Description are TRUE, then all document classes are searched.

See the dmaQueryOperator_IsClass operator. This operator can be used to restrict the classes searched to a subset of the tree of classes rooted at the class indicated by the value of dmaProp_SearchableClassId.