|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTSPortalCollection
Factory methods for fields defined by the Plumtree Corporate Portal, and queries that restrict to areas within the portal, such as folders.
Method Summary | |
---|---|
IPTSField |
AdminACL()
Returns the IPTSField for portal objects' admin ACL. |
IPTSQuery |
AdminDirectory()
Query that restricts to the portal's entire admin directory. |
IPTSQuery |
AdminDirectory(int folderID,
boolean includeSubfolders,
java.lang.String[] objTypes)
Query that restricts to a subtree of the portal's admin directory. |
IPTSQuery |
AdminDirectory(java.lang.String objType)
Query that restricts to the portal's entire admin directory. |
IPTSQuery |
AdminDirectory(java.lang.String[] objTypes)
Query that restricts to the portal's entire admin directory. |
IPTSField |
AncestorFolderIDs()
Returns the IPTSField for portal objects' ancestor folder IDs (all ancestors, not just immediate parents). |
IPTSField |
Categories()
Returns the IPTSField for the search-devised categories. |
IPTSField |
ClassID()
Returns the IPTSField for portal objects' class ID. |
java.lang.String |
classIdToObjectType(int classId)
Helper method to map a portal Class ID value to the String object type codes used here. |
IPTSQuery |
Community(int communityID)
Query that restricts to the set of things attached to a community. |
IPTSField |
CommunityLinks()
Returns a string IPTSField containing the IDs of communities this item is
linked to. |
IPTSField |
CrawlerTag()
Returns a string IPTSField containing the crawler tag, if defined, for documents. |
IPTSQuery |
DocDirectory()
Query that restricts to the portal's entire Knowledge Directory. |
IPTSQuery |
DocDirectory(int folderID,
boolean includeSubfolders,
java.lang.String[] objTypes)
Query that restricts to a subtree of the portal's Knowledge Directory. |
IPTSQuery |
DocDirectory(java.lang.String objType)
Query that restricts to the portal's entire Knowledge Directory. |
IPTSField |
DocumentTypeID()
Returns an integer IPTSField containing the document type ID for knowledge directory documents. |
IPTSField |
DocUploadID()
Returns a string IPTSField containing the "document upload ID" for certain knowledge directory documents. |
IPTSField |
DocUploadServer()
Returns a string IPTSField containing the "document upload server" for certain knowledge directory documents. |
IPTSField |
EditACL()
Returns the IPTSField for portal objects' edit ACL. |
IPTSField |
EmailAddress()
Returns a string IPTSField containing the email address, if defined, for users. |
IPTSField |
FolderACL()
Returns the IPTSField for the ACL on portal objects' parent folders. |
IPTSField |
FolderDepth()
Returns an integer IPTSField corresponding to the depth of a folder in the
knowledge directory hierarchy. |
IPTSField |
FolderPath()
Returns the IPTSField for portal objects' folder path. |
IPTSField |
NameSortKey()
Returns a IPTSField for a floating-point value based on the first few characters
of document names. |
IPTSField |
ObjectID()
Returns the IPTSField for portal objects' object ID. |
IPTSField |
ParentFolderIDs()
Returns the IPTSField for portal objects' parent folder ID. |
IPTSField |
PortletAlignment()
Returns the IPTSField for portlet alignment. |
IPTSField |
PortletType()
Returns the IPTSField for portlet type. |
IPTSQuery |
portletTypes(int[] portletTypes,
int[] portletAlignments,
boolean nonCommunityFolderOnly,
boolean nonTemplatingPortletsOnly)
Special factory method to make a query that restricts to specific types of portlets, to support the old API's portlet search options. |
IPTSField |
PortletUserInterfaces()
Returns the IPTSField for portlet user interfaces. |
IPTSField |
Property(int propertyID)
Returns the IPTSFields corresponding to a portal property;
looks up the property by the object ID of the Property object. |
IPTSField |
Property(java.lang.String propertyName)
Returns the IPTSFields corresponding to a portal property;
looks up the property by name. |
IPTSField |
ProviderClassUUID()
Returns a string IPTSField containing the provider UUID for certain types of portal items. |
IPTSField |
ReadACL()
Returns the IPTSField for portal objects' ACL. |
IPTSField |
SelectACL()
Returns the IPTSField for portal objects' select ACL. |
IPTSQuery |
specificPortalItem(int classID,
int objectID)
Special factory method to make a query that matches one and only one portal item, identified by class ID and object ID. |
IPTSQuery |
userTypes(boolean wantRegularUsers,
boolean wantGuestUsers)
Special factory method to make a query that returns users of specific types. |
Methods inherited from interface com.plumtree.server.search.ptapps.IPTSPlumtreeCollection |
---|
Application, CategorizableObjectType, Created, Description, Excerpt, IconURL, IconUUID, Language, LastModified, Name, ObjectType, TextContent, URL |
Methods inherited from interface com.plumtree.server.search.IPTSSearchableCollection |
---|
IsBestBet, Rank, TextQueryDefault |
Method Detail |
---|
IPTSField Property(java.lang.String propertyName) throws PTSInvalidSearchException
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.
propertyName
- the name of the desired property (case sensitive).
PTSInvalidSearchException
- if the property does not exist, is not searchable by the current user, or if there is more than one property with the provided nameIPTSField Property(int propertyID) throws PTSInvalidSearchException
IPTSFields
corresponding to a portal property;
looks up the property by the object ID of the Property object. This may
be one of the intrinsic properties that is present when the portal is
installed (see the PT_PROPERTY_*
values from
PT_INTRINSICS
, not the values from PT_PROPIDS
),
or may be a property that was created or migrated in later.
propertyID
- object ID of the desired property.
PTSInvalidSearchException
- if the property does not exist or is not searchable by the current userIPTSField ObjectID()
IPTSField
for portal objects' object ID. Type int; searchable and retrievable.
IPTSField ClassID()
IPTSField
for portal objects' class ID. Type String; searchable and retrievable.
IPTSField ReadACL()
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.
IPTSField FolderACL()
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.
IPTSField SelectACL()
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.
IPTSField EditACL()
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.
IPTSField AdminACL()
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.
IPTSField ParentFolderIDs()
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.
IPTSField AncestorFolderIDs()
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.
IPTSField FolderPath()
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).
IPTSField Categories()
IPTSField
for the search-devised categories.
Categories are created when search applies clustering to results
IPTSField FolderDepth()
IPTSField
corresponding to the depth of a folder in the
knowledge directory hierarchy. Defined only for document folder results. Searchable and retrievable.
IPTSField CommunityLinks()
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.
IPTSField ProviderClassUUID()
IPTSField
containing the provider UUID for certain types of portal items.
IPTSField EmailAddress()
IPTSField
containing the email address, if defined, for users.
Equivalent to property 11.
IPTSField CrawlerTag()
IPTSField
containing the crawler tag, if defined, for documents.
Equivalent to property 9.
IPTSField DocumentTypeID()
IPTSField
containing the document type ID for knowledge directory documents.
IPTSField DocUploadServer()
IPTSField
containing the "document upload server" for certain knowledge directory documents.
Equivalent to property 61.
IPTSField DocUploadID()
IPTSField
containing the "document upload ID" for certain knowledge directory documents.
Equivalent to property 62.
IPTSField NameSortKey()
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.
IPTSField PortletType()
IPTSField
for portlet type. Defined only for Portlet results.
Type String, searchable and retrievable, contains one of the values from PT_GADGET_TYPES
.
IPTSField PortletAlignment()
IPTSField
for portlet alignment. Defined only for Portlet results.
Type String, searchable and retrievable, contains one of the values from PT_GADGET_ALIGNMENTS
.
IPTSField PortletUserInterfaces()
IPTSField
for portlet user interfaces. Defined only for Portlet results.
Type String, searchable and retrievable.
IPTSQuery DocDirectory()
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
IPTSQuery DocDirectory(java.lang.String objType)
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
objType
- Type (PTSConstants.TYPE_KD_DOCUMENTS
or PTSConstants.TYPE_KD_FOLDERS
) to search forIPTSQuery DocDirectory(int folderID, boolean includeSubfolders, java.lang.String[] objTypes)
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
folderID
- ID of folder to be searched.includeSubfolders
- Whether to also search subfolders of folderID.objTypes
- Types (PTSConstants.TYPE_KD_DOCUMENTS
and/or PTSConstants.TYPE_KD_FOLDERS
) to search forIPTSQuery AdminDirectory()
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
IPTSQuery AdminDirectory(java.lang.String objType)
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
objType
- A single object type to be returned from the query. Must be an object type from PTSConstants.TYPE_*
that can be stored in the Admin Directory (any portal type other than KD_DOCUMENTS
and KD_FOLDERS
); if not an exception is thrown.
If null, any type is returned.IPTSQuery AdminDirectory(java.lang.String[] objTypes)
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
objTypes
- Object types to be returned from the query. Must be object types from PTSConstants.TYPE_*
that can be stored in the Admin Directory (any portal type other than KD_DOCUMENTS
and KD_FOLDERS
); if not an exception is thrown.
If null, any type is returned. May not be an empty array.IPTSQuery AdminDirectory(int folderID, boolean includeSubfolders, java.lang.String[] objTypes)
IPTSQueryRequest.restrictTo
, or used as a subquery of an IPTSBooleanQuery
.
folderID
- ID of folder to be searched.includeSubfolders
- Whether to also search subfolders of folderID.objTypes
- Object types to be returned from the query. Must be object types from PTSConstants.TYPE_*
that can be stored in the Admin Directory (any portal type other than KD_DOCUMENTS
and KD_FOLDERS
); if not an exception is thrown.
If null, any type is returned. May not be an empty array.IPTSQuery Community(int communityID)
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)
.
communityID
- ID of community to searchIPTSQuery portletTypes(int[] portletTypes, int[] portletAlignments, boolean nonCommunityFolderOnly, boolean nonTemplatingPortletsOnly)
portletTypes
- values from PT_GADGET_TYPES; null to not constrain by typeportletAlignments
- values from PT_GADGET_ALIGNMENTS; null to not constrain by alignmentnonCommunityFolderOnly
- if true, returned portlets may not be in community foldersnonTemplatingPortletsOnly
- if true, returned portlets may not be templating portletsIPTSQuery userTypes(boolean wantRegularUsers, boolean wantGuestUsers)
wantRegularUsers
and wantGuestUsers
must
be true
.
wantRegularUsers
- true
if non-guest users should be returned by this query.wantGuestUsers
- true
if guest users should be returned by this query.IPTSQuery specificPortalItem(int classID, int objectID)
classID
- class id of the desired item.objectID
- object id of the desired item.java.lang.String classIdToObjectType(int classId)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |