WebCenter Interaction API  
 

IPTSCollabCollection Members

IPTSCollabCollection overview

Public Instance Methods

public methodACL Field containing the Collab Server ACL (access control list) for this result. Note that this does not correspond to the portal's numbering of usergroups and users. Type String; retrievable but not searchable.
public methodCollabServerOverloaded. Query that restricts to all Collab projects and object types. May be passed into IPTSQueryRequest.restrictTo, or used as a subquery of an IPTSBooleanQuery.
public methodIconAltTextID Field containing an index into the portal string file ptmsgs_collabserverobjecttypes.xml with user-displayable alt-text for this result (for example, "Collaboration Server Task List"). Type String; searchable and retrievable.
public methodObjectTypeCode Field containing a Collab-specific code for the object type. This is most useful in the context of Collab-only queries.. see IPTSPlumtreeCollection.ObjectType for a more general notion of object type. Type String; searchable and retrievable.
public methodParentProjectID Field containing the ID of the project that contains this item. Type String; searchable and retrievable.
public methodParentProjectName Field containing the name of the project that contains this item. Type String; searchable and retrievable.
public methodParentProjectURLSuffix Field containing URL suffix used to build an URL leading to the result's project home page. See URLPrefix for information on assembling Collab URLs. Type String; searchable and retrievable.
public methodPortletOrWSID Field containing the ID of a portlet or web service that may be used to gateway clickthrough URLs (including IPTSPlumtreeCollection.URL) for this item. A positive number indicates a portlet ID; a negative number indicates a webservice ID (-1 times the number is the actual ID). See URLPrefix for information on assembling Collab URLs. Type String; retrievable but not searchable (will be the same for all Collab items).
public methodProjectOverloaded. Query that restricts to a specified Collab project. May be passed into IPTSQueryRequest.restrictTo, or used as a subquery of an IPTSBooleanQuery.
public methodProjectsForCommunity Query that restricts to Collab projects associated with a particular portal community. May be passed into IPTSQueryRequest.restrictTo, or used as a subquery of an IPTSBooleanQuery.
public methodPropertiesURLSuffix Field containing URL suffix used to build an URL leading to the result's "properties" page. See URLPrefix for information on assembling Collab URLs. Type String; searchable and retrievable.
public methodURLPrefix Field containing the URL prefix for Collaboration Server. Type String; retrievable but not searchable (will be the same for all Collab items). To assemble a complete Collaboration Server URL, concatenate (portal gateway URL root, including field IPTSCollabCollection.PortletOrWSID()) + (field URLPrefix) + (field IPTSPlumtreeCollection.URL(), IPTSCollabCollection.PropertiesURLSuffix(), or IPTSCollabCollection.ProjectURLSuffix()).

See Also

IPTSCollabCollection Interface | com.plumtree.server.search.ptapps Namespace