API Instantiation Methods
The following is a list of the other methods used with the session object to instantiate an API object such as a Component Interface, a tree structure, and so on.
Component Interface:
FindCompIntfcs(ComponentName): returns a collection of component interfaces based on the partial Component Interface name.
GetCompIntfc(COMPINTFC.ComponentName): returns a Component Interface object.
ValidateCompIntfc(ComponentInterfaceName): indicates the success or failure of component interface validations.
Portal Registry:
FindPortalRegistries(partial_name): returns a collection of PortalRegistry objects.
GetLocalNode(): returns a node object.
GetNodes(): returns a collection of node objects.
GetPortalRegistry(): returns a PortalRegistry object.
GetRemoteNodes(): returns a collection of node objects.
GetActualRemoteNodes(): returns a collection of remote node objects only.
Query:
FindQueryDBRecords():returns a reference to a QueryDBRecord collection, filled with zero or more records.
FindQueries():returns a reference to a Query collection, filled with zero or more queries.
FindQueriesDateRange(StartDateString, EndDateString): returns a reference to a Query collection, filled with zero or more queries that match the specified date range.
GetQuery(): returns a query object.
GetQuerySecurityProfile(): a QuerySecurityProfile object.
SearchQueryDBRecord(SearchType, Pattern, CaseSensitive): returns a QueryDBRecord collection.
SearchPrivateQueries(QueryType, SearchType, Pattern, CaseSensitive): a query collection.
SearchPublicQueries(QueryType, SearchType, Pattern, CaseSensitive): a query collection.
Search:
GetSearchIndexes(): returns a SearchIndexes collection.
GetSearchQuery(): returns a search query object.
Tree:
GetTree(): returns a tree object.
GetTreeStructure(): returns a tree structure object.