com.plumtree.server
Class PT_CARD_SETTINGS

java.lang.Object
  com.plumtree.server.PT_CARD_SETTINGS

public final class PT_CARD_SETTINGS
extends java.lang.Object

Plumtree Card Settings. Note that some of these settings are persistant and some aren't, Some are for new cards only and some aren't. Some are for internal use only.

Version:

$Revision$

Author:

StephenC

See Also:

IPTCard

Field Summary

static int	PT_CARD_COMPLETEURLONSTORE this flag is set when the card needs to add its objectid to the url on store.
static int	PT_CARD_DESCRIPTIONALREADYSET a non-persistant version of PT_CARD_OVERWRITEDESCRIPTION, defaults to 0.
static int	PT_CARD_EXISTINGCARD internal use only
static int	PT_CARD_HASRELATIVEDOCUMENTURL returns 0/1 indicating whether or not the DocumentURL property is relative.
static int	PT_CARD_INDEXONSTORE Indicates whether the changes should be immediately persisted to Search Index or whether it should be left to the Search Update Agent for updating.
static int	PT_CARD_INHERITPARENTFOLDERPERMISSIONS if set to TRUE, this card will get a security profile identical to that of its parent folder (or merged acl of all its parent folders).
static int	PT_CARD_INSERTAPPROVED flag which is set if the card should be added to PT_CARD_PARENTFOLDERIDS approved.
static int	PT_CARD_NEVERFULLTEXTINDEX a persistant flag which, if set, will prevent this card's document from ever getting indexed.
static int	PT_CARD_ORIG_XML internal use only, original card xml string.
static int	PT_CARD_OVERWRITEDESCRIPTION persistant flag which indicates whether the search summary should be used to overwrite the description on the card.
static int	PT_CARD_OVERWRITENAME persistant flag which indicates whether the search name should be used to overwrite the name on the card.
static int	PT_CARD_PARENTFOLDERIDS Folders into which this Card should be inserted upon store (for newly created cards only).
static int	PT_CARD_PROVIDERURLINFO the URL Info from the Data Source Provider, if the PT_CARD_COMPLETEURLONSTORE is set.
static int	PT_CARD_RAWDOCUMENTURL returns the raw DocumentURL value.
static int	PT_CARD_SEARCHENGINE Indicates whether the card needs to be updated in the search index.
static int	PT_CARD_TEMPORARYCARDID Indicates whether the Card is temporary.
static int	PT_CARD_UNCLASSIFIEDCARD this value will be set to TRUE by the crawler if the card is being placed in Unclassified Cards.
static int	PT_CARD_UPDATEFULLTEXTINDEX flag which indicates whether the full-text search index needs to be updated for this card.

Constructor Summary

PT_CARD_SETTINGS()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PT_CARD_TEMPORARYCARDID

public static final int PT_CARD_TEMPORARYCARDID

Indicates whether the Card is temporary. If not, then the value is zero. If so, then the value is the cardID

See Also:

Constant Field Values

PT_CARD_SEARCHENGINE

public static final int PT_CARD_SEARCHENGINE

Indicates whether the card needs to be updated in the search index.

See Also:

Constant Field Values

PT_CARD_PARENTFOLDERIDS

public static final int PT_CARD_PARENTFOLDERIDS

Folders into which this Card should be inserted upon store (for newly created cards only). The value is an array of folderIDs.

See Also:

Constant Field Values

PT_CARD_INHERITPARENTFOLDERPERMISSIONS

public static final int PT_CARD_INHERITPARENTFOLDERPERMISSIONS

if set to TRUE, this card will get a security profile identical to that of its parent folder (or merged acl of all its parent folders). This setting is NOT persistent, is for newly created cards only, and should only be set by clients when doing manual card import.

See Also:

Constant Field Values

PT_CARD_INSERTAPPROVED

public static final int PT_CARD_INSERTAPPROVED

flag which is set if the card should be added to PT_CARD_PARENTFOLDERIDS approved.

See Also:

Constant Field Values

PT_CARD_UPDATEFULLTEXTINDEX

public static final int PT_CARD_UPDATEFULLTEXTINDEX

flag which indicates whether the full-text search index needs to be updated for this card. Note that this may be false either because the index really doesn't need to be updated, or because the document type says not to index.

See Also:

Constant Field Values

PT_CARD_NEVERFULLTEXTINDEX

public static final int PT_CARD_NEVERFULLTEXTINDEX

a persistant flag which, if set, will prevent this card's document from ever getting indexed. Used when a document causes problems in the search engine.

See Also:

Constant Field Values

PT_CARD_OVERWRITEDESCRIPTION

public static final int PT_CARD_OVERWRITEDESCRIPTION

persistant flag which indicates whether the search summary should be used to overwrite the description on the card.

See Also:

Constant Field Values

PT_CARD_COMPLETEURLONSTORE

public static final int PT_CARD_COMPLETEURLONSTORE

this flag is set when the card needs to add its objectid to the url on store.

See Also:

Constant Field Values

PT_CARD_PROVIDERURLINFO

public static final int PT_CARD_PROVIDERURLINFO

the URL Info from the Data Source Provider, if the PT_CARD_COMPLETEURLONSTORE is set.

See Also:

Constant Field Values

PT_CARD_UNCLASSIFIEDCARD

public static final int PT_CARD_UNCLASSIFIEDCARD

this value will be set to TRUE by the crawler if the card is being placed in Unclassified Cards. This is not persistant and only for internal crawler use.

See Also:

Constant Field Values

PT_CARD_RAWDOCUMENTURL

public static final int PT_CARD_RAWDOCUMENTURL

returns the raw DocumentURL value. Won't be fixed up by the system if it's relative. R/O

See Also:

Constant Field Values

PT_CARD_HASRELATIVEDOCUMENTURL

public static final int PT_CARD_HASRELATIVEDOCUMENTURL

returns 0/1 indicating whether or not the DocumentURL property is relative. R/O

See Also:

Constant Field Values

PT_CARD_OVERWRITENAME

public static final int PT_CARD_OVERWRITENAME

persistant flag which indicates whether the search name should be used to overwrite the name on the card.

See Also:

Constant Field Values

PT_CARD_DESCRIPTIONALREADYSET

public static final int PT_CARD_DESCRIPTIONALREADYSET

a non-persistant version of PT_CARD_OVERWRITEDESCRIPTION, defaults to 0. setting this to 1 implies that the card has already received a description, and other parts of the server (such as search summary generation) shouldn't override it.

See Also:

Constant Field Values

PT_CARD_ORIG_XML

public static final int PT_CARD_ORIG_XML

internal use only, original card xml string.

See Also:

Constant Field Values

PT_CARD_EXISTINGCARD

public static final int PT_CARD_EXISTINGCARD

internal use only

See Also:

Constant Field Values

PT_CARD_INDEXONSTORE

public static final int PT_CARD_INDEXONSTORE

Indicates whether the changes should be immediately persisted to Search Index or whether it should be left to the Search Update Agent for updating.

See Also:

Constant Field Values

Constructor Detail

PT_CARD_SETTINGS

public PT_CARD_SETTINGS()