Public Instance Methods
 AdminACL | Returns the IPTSField for portal objects' admin ACL. Type String; retrievable but not searchable. Tokens in this String are whitespace-separated user IDs (prefixed with 'u') and group IDs (no prefix) of users or groups that can administer the item. |
| AdminDirectory | Overloaded. Query that restricts to the portal's entire admin directory. Any object type in the admin directory may be returned. May be passed into IPTSQueryRequest.restrictTo, or used as a subquery of an IPTSBooleanQuery. |
| AncestorFolderIDs | Returns the IPTSField for portal objects' ancestor folder IDs (all ancestors, not just immediate parents). Type String; retrievable but not searchable (use one of the IPTSQuery objects defined in this interface instead). Format is 'ddX' (where XXX is the folder ID) for document directory items, and 'odX' for admin directory items. IDs are separated by whitespace. |
| Categories | Returns the IPTSField for the search-devised categories. Categories are created when search applies clustering to results |
| ClassID | Returns the IPTSField for portal objects' class ID. Type String; searchable and retrievable. |
| classIdToObjectType | Helper method to map a portal Class ID value to the String object type codes used here. Returns null if the class id is invalid or nonsearchable. |
| Community | Query that restricts to the set of things attached to a community. (can include items linked from the Community Knowledge Directory, and portlets used in the community). May be passed into IPTSQueryRequest.restrictTo, or used as a subquery of an IPTSBooleanQuery. To restrict to particular object types, AND this query with a query returned by AdminDirectory(folderID, includeSubfolders, objTypes) or DocDirectory(folderID, includeSubfolders, objTypes). |
| CommunityLinks | Returns a string IPTSField containing the IDs of communities this item is linked to. Defined only for documents and document folders (in the community knowledge directory), users (in the community knowledge directory, not all users that are members of the community), portlets (used on a community page), and communities (related via a subcommunity relationship). Retrieveable but not searchable.. use the query returned by Community instead. |
| CrawlerTag | Returns a string IPTSField containing the crawler tag, if defined, for documents. Equivalent to property 9. |
| DocDirectory | Overloaded. Query that restricts to the portal's entire Knowledge Directory. May be passed into IPTSQueryRequest.restrictTo, or used as a subquery of an IPTSBooleanQuery. |
| DocumentTypeID | Returns an integer IPTSField containing the document type ID for knowledge directory documents. |
| DocUploadID | Returns a string IPTSField containing the "document upload ID" for certain knowledge directory documents. Equivalent to property 62. |
| DocUploadServer | Returns a string IPTSField containing the "document upload server" for certain knowledge directory documents. Equivalent to property 61. |
| EditACL | Returns the IPTSField for portal objects' edit ACL. Type String; retrievable but not searchable. Tokens in this String are whitespace-separated user IDs (prefixed with 'u') and group IDs (no prefix) of users or groups that can edit the item. |
| EmailAddress | Returns a string IPTSField containing the email address, if defined, for users. Equivalent to property 11. |
| FolderACL | Returns the IPTSField for the ACL on portal objects' parent folders. Type String; retrievable but not searchable. Tokens in this String are whitespace-separated user IDs (prefixed with 'u') and group IDs (no prefix) of users or groups that can see the item's folder. |
| FolderDepth | Returns an integer IPTSField corresponding to the depth of a folder in the knowledge directory hierarchy. Defined only for document folder results. Searchable and retrievable. |
| FolderPath | Returns the IPTSField for portal objects' folder path. This is the full-text version containing folder names, not IDs. Type String; searchable and retrievable, and may be used for group-by (this is the field used for "group by folder" in the portal UI). |
| NameSortKey | Returns a IPTSField for a floating-point value based on the first few characters of document names. Defined only for Knowledge Directory documents. Plumtree Search does not support ordering by a String field, so you cannot sort by Name, for example. Ordering by this field instead will sometimes provide a "good enough" replacement for sorting by name. |
| ObjectID | Returns the IPTSField for portal objects' object ID. Type int; searchable and retrievable. |
| ParentFolderIDs | Returns the IPTSField for portal objects' parent folder ID. Type String; retrievable but not searchable (use one of the IPTSQuery objects defined in this interface instead). Format is 'ddX' (where XXX is the folder ID) for document directory items, and 'odX' for admin directory items. Note that document directory items may have more than one immediate parent folder; in this case the IDs will be whitespace-separated. |
| PortletAlignment | Returns the IPTSField for portlet alignment. Defined only for Portlet results. Type String, searchable and retrievable, contains one of the values from PT_GADGET_ALIGNMENTS. |
| PortletType | Returns the IPTSField for portlet type. Defined only for Portlet results. Type String, searchable and retrievable, contains one of the values from PT_GADGET_TYPES. |
| portletTypes | Special factory method to make a query that restricts to specific types of portlets, to support the old API's portlet search options. Used by the Add Portlets page. |
| PortletUserInterfaces | Returns the IPTSField for portlet user interfaces. Defined only for Portlet results. Type String, searchable and retrievable. |
| Property | Overloaded. Returns the IPTSFields corresponding to a portal property; looks up the property by name. The property may be one of the intrinsic properties that is present when the portal is installed, or may be one that was created (or migrated in) afterwards. |
| ProviderClassUUID | Returns a string IPTSField containing the provider UUID for certain types of portal items. |
| ReadACL | Returns the IPTSField for portal objects' ACL. Type String; retrievable but not searchable. Tokens in this String are whitespace-separated user IDs (prefixed with 'u') and group IDs (no prefix) of users or groups that can read the item. |
| SelectACL | Returns the IPTSField for portal objects' select ACL. Type String; retrievable but not searchable. Tokens in this String are whitespace-separated user IDs (prefixed with 'u') and group IDs (no prefix) of users or groups that can select the item. |
| specificPortalItem | Special factory method to make a query that matches one and only one portal item, identified by class ID and object ID. Note that user security still applies, so either 0 or 1 items will match this query. |
| userTypes | Special factory method to make a query that returns users of specific types. At least one of wantRegularUsers and wantGuestUsers must be true. |
See Also
IPTSPortalCollection Interface | com.plumtree.server.search.ptapps Namespace