com.plumtree.server
Class PT_SEARCH_INTERNAL_FIELD

java.lang.Object
  extended by com.plumtree.server.PT_SEARCH_INTERNAL_FIELD

public final class PT_SEARCH_INTERNAL_FIELD
extends java.lang.Object

This enumeration lists special "internal fields" that can be requested by calling IPTSearchResponse.GetResultInternalField. These are items that do not correspond to Plumtree properties and whose importance does not merit a separate IPTSearchResponse method.

All have values of type String; in some cases the String simply contains a formatted integer.

Version:
$Revision$
Author:
CraigS
See Also:
IPTSearchResponse

Field Summary
static int PT_SEARCH_IF_BESTBETKEY
          The first half of the search server key for this item, used in conjunction with IPTSearchBestBetMaintenance to make the item into a Best Bet target.
static int PT_SEARCH_IF_COLLAB_ICON_ALT_TEXT
          Defined for Collab results only; a numeric ID for the alt-text associated with the item's icon.
static int PT_SEARCH_IF_COLLAB_PORTLET_ID
          Defined for Collab results only; the ID of a Collab portlet (not necessarily associated with the item; Collab portlets are not tied to individual projects or objects the way Content portlets are).
static int PT_SEARCH_IF_COLLAB_PROJ_NAME
          Defined for Collab results only; the name of the project in which the item appears.
static int PT_SEARCH_IF_COLLAB_PROJ_URL
          Defined for Collab results only; the URL that opens the item's Project page (when prepended with the value of PT_SERACH_IF_COLLAB_URL_PREFIX).
static int PT_SEARCH_IF_COLLAB_PROPS_URL
          Defined for Collab results only; the URL that opens the item's Properties page (when prepended with the value of PT_SERACH_IF_COLLAB_URL_PREFIX).
static int PT_SEARCH_IF_COLLAB_URL_PREFIX
          Defined for Collab results only; an URL fragment to be prepended to other Collab item URLs to generate a complete (but not gatewayed) Collab URL.
static int PT_SEARCH_IF_CONTENT_PORTLET_ID
          Defined for Content results only; the IDs of the portlets associated with this item.
static int PT_SEARCH_IF_CONTENT_PUBLISHED_USER
          Defined for Content results only; the username of the user who last published this item.
static int PT_SEARCH_IF_CONTENT_WS_ID
          Defined for Content results only; the ID of a webservice object that is guaranteed to be able to gateway the Content item.
static int PT_SEARCH_IF_GADGET_ALIGNMENT
          Defined for portlet results only; the portlet alignment.
static int PT_SEARCH_IF_GADGET_TYPE
          Defined for portlet results only; the portlet type.
static int PT_SEARCH_IF_GADGET_USER_INTERFACES
          Defined for portlet results only; the allowed portlet user interfaces.
static int PT_SEARCH_IF_PARENTIDS
          IDs of parent folders of this item, prefixed by "dd" for a document folder or "od" for an admin folder.
 
Constructor Summary
PT_SEARCH_INTERNAL_FIELD()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PT_SEARCH_IF_PARENTIDS

public static final int PT_SEARCH_IF_PARENTIDS
IDs of parent folders of this item, prefixed by "dd" for a document folder or "od" for an admin folder. Note that documents may have more than one parent folder, in which case the folder IDs are separated by spaces.

See Also:
Constant Field Values

PT_SEARCH_IF_GADGET_TYPE

public static final int PT_SEARCH_IF_GADGET_TYPE
Defined for portlet results only; the portlet type.

See Also:
Constant Field Values

PT_SEARCH_IF_GADGET_ALIGNMENT

public static final int PT_SEARCH_IF_GADGET_ALIGNMENT
Defined for portlet results only; the portlet alignment.

See Also:
Constant Field Values

PT_SEARCH_IF_BESTBETKEY

public static final int PT_SEARCH_IF_BESTBETKEY
The first half of the search server key for this item, used in conjunction with IPTSearchBestBetMaintenance to make the item into a Best Bet target.

See Also:
com.plumtree.server.IPTSearchBestBetMaintenance, Constant Field Values

PT_SEARCH_IF_COLLAB_PROPS_URL

public static final int PT_SEARCH_IF_COLLAB_PROPS_URL
Defined for Collab results only; the URL that opens the item's Properties page (when prepended with the value of PT_SERACH_IF_COLLAB_URL_PREFIX).

See Also:
Constant Field Values

PT_SEARCH_IF_COLLAB_PROJ_URL

public static final int PT_SEARCH_IF_COLLAB_PROJ_URL
Defined for Collab results only; the URL that opens the item's Project page (when prepended with the value of PT_SERACH_IF_COLLAB_URL_PREFIX).

See Also:
Constant Field Values

PT_SEARCH_IF_COLLAB_ICON_ALT_TEXT

public static final int PT_SEARCH_IF_COLLAB_ICON_ALT_TEXT
Defined for Collab results only; a numeric ID for the alt-text associated with the item's icon.

See Also:
Constant Field Values

PT_SEARCH_IF_CONTENT_PUBLISHED_USER

public static final int PT_SEARCH_IF_CONTENT_PUBLISHED_USER
Defined for Content results only; the username of the user who last published this item.

See Also:
Constant Field Values

PT_SEARCH_IF_CONTENT_PORTLET_ID

public static final int PT_SEARCH_IF_CONTENT_PORTLET_ID
Defined for Content results only; the IDs of the portlets associated with this item. As of the 6.0 portal and 6.1.1 Content Server releases, this may contain more than one portlet ID, separated by whitespace. A given user may not have access to some of these portlets, so they should not be used for building clickthru URLS that gateway the content item (of course, you could check the portlet ACL, but this might be expensive for big search result sets). See PT_SEARCH_IF_CONTENT_WS_ID for another way to build gatewayed URLs for Content items.

See Also:
Constant Field Values

PT_SEARCH_IF_COLLAB_PORTLET_ID

public static final int PT_SEARCH_IF_COLLAB_PORTLET_ID
Defined for Collab results only; the ID of a Collab portlet (not necessarily associated with the item; Collab portlets are not tied to individual projects or objects the way Content portlets are).

See Also:
Constant Field Values

PT_SEARCH_IF_COLLAB_URL_PREFIX

public static final int PT_SEARCH_IF_COLLAB_URL_PREFIX
Defined for Collab results only; an URL fragment to be prepended to other Collab item URLs to generate a complete (but not gatewayed) Collab URL.

See Also:
Constant Field Values

PT_SEARCH_IF_GADGET_USER_INTERFACES

public static final int PT_SEARCH_IF_GADGET_USER_INTERFACES
Defined for portlet results only; the allowed portlet user interfaces.

See Also:
Constant Field Values

PT_SEARCH_IF_COLLAB_PROJ_NAME

public static final int PT_SEARCH_IF_COLLAB_PROJ_NAME
Defined for Collab results only; the name of the project in which the item appears.

See Also:
Constant Field Values

PT_SEARCH_IF_CONTENT_WS_ID

public static final int PT_SEARCH_IF_CONTENT_WS_ID
Defined for Content results only; the ID of a webservice object that is guaranteed to be able to gateway the Content item. Currently this just returns the ID of the Published Content Web Service, obtained via a database lookup of the (constant) UUID for the webservice.

See Also:
Constant Field Values
Constructor Detail

PT_SEARCH_INTERNAL_FIELD

public PT_SEARCH_INTERNAL_FIELD()


Copyright 2008 Plumtree Software Inc. All Rights Reserved.