|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTSPlumtreeCollection
Interface that returns common fields (IPTSField
instances)
that appear in objects indexed by any Plumtree application.
See subinterfaces IPTSPortalCollection
, IPTSCollabCollection
,
IPTSContentCollection
for additional fields specific to each Plumtree application,
and IPTSSearchableCollection
(in the parent package) for fields common
to both Plumtree and non-Plumtree applications.
Method Summary | |
---|---|
IPTSField |
Application()
Application that owns this object. |
IPTSField |
CategorizableObjectType()
An alternative format of the object type that the portal UI uses to group by object type. |
IPTSField |
Created()
Date/time the object was created. |
IPTSField |
Description()
Description of the object. |
IPTSField |
Excerpt()
Excerpts from the Description and TextContent fields that matched the
query. |
IPTSField |
IconURL()
URL for an icon representing the object's type. |
IPTSField |
IconUUID()
UUID for a searchable item's icon. |
IPTSField |
Language()
Object's language. |
IPTSField |
LastModified()
Date/time the object was last modified. |
IPTSField |
Name()
Name of the object. |
IPTSField |
ObjectType()
Fully-qualified type of this object. |
IPTSField |
TextContent()
Full text content of a document. |
IPTSField |
URL()
Clickthrough URL for the object. |
Methods inherited from interface com.plumtree.server.search.IPTSSearchableCollection |
---|
IsBestBet, Rank, TextQueryDefault |
Method Detail |
---|
IPTSField Application()
PTSConstants.PORTAL_PREFIX
,
PTSConstants.COLLAB_PREFIX
,
PTSConstants.CONTENT_PREFIX
.
Type String. This field is retrievable, but not searchable, and may not be used for group-by. Instead
of querying on this field, restrict your query using one of the IPTSQuery
objects
returned by factory methods in
IPTSPortalCollection
, IPTSCollabCollection
, or
IPTSContentCollection
(for example, IPTSPortalCollection.DocDirectory
).
IPTSField ObjectType()
TYPE_
values
defined in PTSConstants
, such as PTSConstants.TYPE_KD_DOCUMENTS
.
Note that these constants are prefixed with the value of the Application
field.
The purpose of this field is to return a cross-application object type value for situations
where the query may match items created by any Plumtree application.
IPTSPortalCollection
and IPTSCollabCollection
contain other
object-type-like fields (such as IPTSPortalCollection.ClassID
and
ITPSCollabCollection.CollabType
) that may be
more useful within those individual applications. Also, see CategorizableObjectType
below.
Type String. This field is retrievable, but not searchable, and may not be used for group-by. Instead
of querying on this field, restrict your query using one of the IPTSQuery
objects
returned by factory methods in
IPTSPortalCollection
, IPTSCollabCollection
, or
IPTSContentCollection
(for example, IPTSPortalCollection.DocDirectory
).
IPTSField CategorizableObjectType()
PTCARD
or PTCOMMUNITY
. For Collab or Content Server items, the value is
simply PTCOLLAB
or PTCONTENT
, respectively.
Type String. This field is retrievable, but not searchable. Instead
of querying on this field, restrict your query using one of the IPTSQuery
objects
returned by factory methods in
IPTSPortalCollection
, IPTSCollabCollection
, or
IPTSContentCollection
(for example, IPTSPortalCollection.DocDirectory
).
IPTSField Name()
IPTSField Description()
IPTSField Language()
IPTSField Created()
IPTSField LastModified()
IPTSField IconURL()
IPTSField IconUUID()
IPTSField URL()
IPTSPortalCollection.ClassID
and IPTSPortalCollection.ObjectID
fields.
For Collab items, this URL is actually a suffix that must have the remote server URL
prepended, and then must be gatewayed using a valid webservice ID. See
IPTSCollabCollection.CollabURLPrefix
for more information.
IPTSField TextContent()
Excerpt
field for an alternative.
IPTSField Excerpt()
Description
and TextContent
fields that matched the
query. Individual excerpts are enclosed in <excerpt> tags.
Search query keywords within excerpts are enclosed in <keyword> tags.
The actual excerpts themselves are HTML-encoded, so you may safely do string
replacement on the tags to put them in whatever form you wish (e.g.
replace them with HTML formatting tags).
This pseudofield is an easier-to-use alternative to calling
IPTSResult.getFieldExcerpts
.
Type is String, field is retrievable, but not searchable (it does not make sense to
query on this pseudofield).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |