com.plumtree.server
Interface IPTCatalog

All Superinterfaces:
IPTUnknown

public interface IPTCatalog
extends IPTUnknown

The interface representing the Knowledge Directory (Catalog). The Knowledge Directory allows you to browse, move, create, and edit document links (cards) and document folders. It also manages the filters and related resources associated with each folder. Objects in the knowledge directory can be created directly through this interface.


Method Summary
 java.lang.Object[] AddCardToMultipleFolders(int lCardID, int[] vsaTargetFolderIDs, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to multiple target document folders.
 java.lang.Object[] AddCardToMultipleFolders(int lCardID, int vsaTargetFolderIDs, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to a single target document folder.
 java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID, int[] vsaTargetFolderIDs, int[] vsaRankInEachFolder, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to multiple target document folders with ranking.
 java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID, int[] vsaTargetFolderIDs, int vsaRankInEachFolder, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to multiple target document folders with ranking.
 java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID, int vsaTargetFolderIDs, int[] vsaRankInEachFolder, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to a single target document folder with ranking.
 java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID, int vsaTargetFolderIDs, int vsaRankInEachFolder, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to a single target document folder with ranking.
 java.lang.Object[] AddMultipleCardsToFolder(int[] vsaCardIDs, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds multiple documents to a single target document folder.
 java.lang.Object[] AddMultipleCardsToFolder(int vsaCardIDs, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to a single target document folder.
 java.lang.Object[] AddMultipleCardsToFolderWithRank(int[] vsaCardIDs, int[] vsaRankForEachCard, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds multiple documents to a single target document folder with ranking.
 java.lang.Object[] AddMultipleCardsToFolderWithRank(int[] vsaCardIDs, int vsaRankForEachCard, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds multiple documents to a single target document folder with ranking.
 java.lang.Object[] AddMultipleCardsToFolderWithRank(int vsaCardIDs, int[] vsaRankForEachCard, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to a single target document folder with ranking.
 java.lang.Object[] AddMultipleCardsToFolderWithRank(int vsaCardIDs, int vsaRankForEachCard, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Adds a single document to a single target document folder with ranking.
 void ApproveCardWhereUnapproved(int lCardID)
          Approves the documents in each of the Folders that document belongs to.
 void ClearRankFromAllCardsInFolder(int lFolderID)
          Clears the rank of all the documents within the specified document folder.
 void CopyFolder(int lFolderID, int lTargetFolderID, boolean bRecursive, boolean bCopyCards)
          Copies the document folder.
 IPTCard CreateCard()
          Creates a blank document.
 IPTFolder CreateFolder(int lParentFolderID)
          Creates a document folder.
 java.lang.Object[] DeleteCards(int vsaCardIDs)
          Deletes a single document from the knowledge directory.
 java.lang.Object[] DeleteCards(int[] vsaCardIDs)
          Deletes multiple documents from the catalog.
 void DeleteFolder(int lFolderID, boolean bRecursive)
          Deletes a document folder.
 void DiscardCardWhereUnapproved(int lCardID)
          Discards documents from folders that denies the document access.
 com.plumtree.openfoundation.util.IXPPropertyBag GenerateCardStatusReport()
          Queries the search index and database to generate a status report of the documents in the catalog
 int GetCardRank(int lCardID, int lFolderID)
          Returns the ranking of a specific document in a specific document folder.
 IPTQueryResult GetCardSubmitDataSources(int lCardSubmitType)
          Returns the DataSources that support the given document submission type.
 IPTQueryResult GetOrderByProperties()
          Returns the document properties by which documents by in a database query.
 IPTFolder GetRootFolder()
          Returns the root folder.
 com.plumtree.openfoundation.util.IXPPropertyBag GetSearchServerStatus()
          Returns the status of the query and failover search servers.
 java.lang.Object GetSettings(int lSettings)
          Deprecated.  
 IPTCatalogStatistics GetStatistics()
          Returns the interface to IPTCatalogStatistics.
 IPTFolder GetUnclassifiedCardsFolder()
          Returns the Unclassified Cards folder.
 boolean IsCatalogObjectAccessible(int lClassID, int lObjectID, int lMinAccessLevel)
          Checks if current user has at least the lMinAccessLevel on either a specific document or folder.
 java.lang.Object[] MoveCards(int lFromFolderID, int[] vsaCardIDs, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Moves multiple document from a single document folder to another single document folder.
 java.lang.Object[] MoveCards(int lFromFolderID, int vsaCardIDs, int lTargetFolderID, int lRequestedApprovalState, boolean bAddOnlyAtSpecifiedApprovalState)
          Moves a single document from a single document folder to another single document folder.
 void MoveFolder(int lFolderID, int lTargetFolderID)
          Moves a document folder into another location.
 IPTCard OpenCard(int lCardID, boolean bLockOnOpen)
          Retrieves an existing document.
 IPTFolder OpenFolder(int lFolderID, boolean bLockOnOpen)
          Retrieves a document folder.
 IPTFolder OpenFolderByPath(java.lang.String bstrFolderPath, boolean bLockOnOpen)
          Retrieves a document folder.
 int QueryCardAccess(int nCardID)
          Returns the access level that the current user has on the document.
 IPTQueryResult QueryCardPaths(int[] vsaCardIDs, boolean bShowUnapproved, boolean bShowAllUnapproved)
          Returns the document folders path of a set of documents.
 IPTQueryResult QueryCardPaths(int vsaCardIDs, boolean bShowUnapproved, boolean bShowAllUnapproved)
          Returns the document folders path of a document.
 IPTQueryResult QueryCards(int nQueryByClassID, int lQueryByObjectID, boolean bShowUnapproved, boolean bShowAllUnapproved, int lPropIDMask, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Returns an IPTQueryResult of documents based on datasourceID, crawlerID, or documenttypeID.
 IPTQueryResult QueryCards(int nQueryByClassID, int lQueryByObjectID, boolean bShowUnapproved, boolean bShowAllUnapproved, int lPropIDMask, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Returns an IPTQueryResult of documents based on datasourceID, crawlerID, or documenttypeID.
 IPTQueryResult QueryFolderPaths(int vsaFolderIDs)
          Returns the folder path of a document folder.
 IPTQueryResult QueryFolderPaths(int[] vsaFolderIDs)
          Returns the folder path of a set of document folders.
 IPTQueryResult QueryFoldersByFilter(int nFilterID)
          Returns an IPTQueryResult of document folders that use a particular classification Filter.
 IPTQueryResult QueryParentFolderIDs(int nFolderID)
          Returns a list of the parent folderIDs.
 IPTQueryResult QueryUnapprovedCards(int nQueryByClassID, int lQueryByObjectID, boolean bShowAll, int lPropIDMask, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
 IPTQueryResult QueryUnapprovedCards(int nQueryByClassID, int lQueryByObjectID, boolean bShowAll, int lPropIDMask, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries and returns documents within a particular branch based on either the datasourceID, crawlerID, or documenttypeID.
 IPTQueryResult QueryUnapprovedCardsByBranch(int lFolderID, boolean bShowAll, int lPropIDMask, int vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
 IPTQueryResult QueryUnapprovedCardsByBranch(int lFolderID, boolean bShowAll, int lPropIDMask, java.lang.Object vOrderBy, int lSkipRows, int lMaxRows, java.lang.Object[][] vQueryFilter)
          Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID
 int QueryUnapprovedCardsCount(int nQueryByClassID, int lQueryByObjectID, boolean bShowAll)
          Returns a count of unapproved documents based on datasourceID, crawlerID, or documenttypeID.
 int QueryUnapprovedCardsCountByBranch(int lFolderID, boolean bShowAll)
          Returns the number of documents within a particular branch of the knowledge directory.
 int QueryUnapprovedCardsCountGlobal(boolean bShowAll)
          Returns the total number of documents in the Knowledge Directory.
 java.lang.Object[] RemoveCards(int lFromFolderID, int vsaCardIDs)
          Removes a single document from a single document folder.
 java.lang.Object[] RemoveCards(int lFromFolderID, int[] vsaCardIDs)
          Removes multiple documents from a single Folder.
 java.lang.Object[] SetApprovalStateByCard(int lCardID, int nApprovalState, java.lang.Object vsaFoldersToSetIn)
          Sets the approval state of a document in a set of document folders.
 java.lang.Object[] SetApprovalStateByFolder(int lFolderID, int nApprovalState, java.lang.Object vsaCards)
          Sets the approval state of multiple document in a single document folder.
 void SetCardRank(int lCardID, int lFolderID, int lRank)
          Sets the ranking for a document in a particular document folder.
 void SetSettings(int Value, java.lang.Object pvValue)
          Deprecated.  
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetRootFolder

public IPTFolder GetRootFolder()
Returns the root folder.
Returns:
IPTFolder of PT_INTRINSICS.PT_FOLDER_ROOTFOLDER

GetUnclassifiedCardsFolder

public IPTFolder GetUnclassifiedCardsFolder()
Returns the Unclassified Cards folder.
Returns:
IPTFolder of PT_INTRINSICS.PT_FOLDER_UNCLASSIFIEDCARDS

GetStatistics

public IPTCatalogStatistics GetStatistics()
Returns the interface to IPTCatalogStatistics.
Returns:
IPTCatalogStatistics

SetSettings

public void SetSettings(int Value,
                        java.lang.Object pvValue)
Deprecated.  


GetSettings

public java.lang.Object GetSettings(int lSettings)
Deprecated.  


OpenFolder

public IPTFolder OpenFolder(int lFolderID,
                            boolean bLockOnOpen)
Retrieves a document folder. To lock an object, user needs at least Edit access right on the folder.
Parameters:
lFolderID - document folder ID to retrieve.
bLockOnOpen - if true, locks the object.
Returns:
IPTFolder of the folder being retrieved

OpenFolderByPath

public IPTFolder OpenFolderByPath(java.lang.String bstrFolderPath,
                                  boolean bLockOnOpen)
Retrieves a document folder. To lock an object, user needs at least Edit access rights on the document folder.
Parameters:
bstrFolderPath - path of the document folder.
bLockOnOpen - lock it?
Returns:
IPTFolder of the document folder being opened

OpenCard

public IPTCard OpenCard(int lCardID,
                        boolean bLockOnOpen)
Retrieves an existing document.
Parameters:
lCardID - cardID of the document being opened.
bLockOnOpen - if true, locks the document.
Returns:
IPTCard of the card being opened

QueryUnapprovedCardsCountGlobal

public int QueryUnapprovedCardsCountGlobal(boolean bShowAll)
Returns the total number of documents in the Knowledge Directory.
Parameters:
bShowAll - if true, returns the total number of unapproved documents, including ones user has no access rights to.
Returns:
int count

QueryUnapprovedCardsCountByBranch

public int QueryUnapprovedCardsCountByBranch(int lFolderID,
                                             boolean bShowAll)
Returns the number of documents within a particular branch of the knowledge directory.
Parameters:
lFolderID - folder ID of the knowledge directory branch.
bShowAll - if true, returns the total number of unapproved documents, including ones user has no acceess rights to.
Returns:
int card count

QueryUnapprovedCardsByBranch

public IPTQueryResult QueryUnapprovedCardsByBranch(int lFolderID,
                                                   boolean bShowAll,
                                                   int lPropIDMask,
                                                   int vOrderBy,
                                                   int lSkipRows,
                                                   int lMaxRows,
                                                   java.lang.Object[][] vQueryFilter)
Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
Parameters:
lClassID - column to select PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID.
lObjectID - objectID of the column to select.
bShowAll - return all objects?
lPropIDMask - mask of propIDs to return
vOrderBy - propID to be sorted on
lSkipRows - number of rows to skip.
lMaxRows - maximum number of rows to return.
vQueryFilter - filter to be applied to the query.
Returns:
IPTQueryResult of the cards being queried

QueryUnapprovedCardsByBranch

public IPTQueryResult QueryUnapprovedCardsByBranch(int lFolderID,
                                                   boolean bShowAll,
                                                   int lPropIDMask,
                                                   java.lang.Object vOrderBy,
                                                   int lSkipRows,
                                                   int lMaxRows,
                                                   java.lang.Object[][] vQueryFilter)
Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID
Parameters:
lClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID
lObjectID - objectID of the column to select on
bShowAll - return all objects?
lPropIDMask - mask of propIDs to return
vOrderBy - propID to be sorted on
lSkipRows - number of rows to skip
lMaxRows - maximum number of rows to return
vQueryFilter - filter to be applied to the query
Returns:
IPTQueryResult of the cards being queried

QueryUnapprovedCardsCount

public int QueryUnapprovedCardsCount(int nQueryByClassID,
                                     int lQueryByObjectID,
                                     boolean bShowAll)
Returns a count of unapproved documents based on datasourceID, crawlerID, or documenttypeID.
Parameters:
nQueryByClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID
lQueryByObjectID - objectID of the column to select on
bShowAll - return all objects?
Returns:
count of the documents being queried

QueryUnapprovedCards

public IPTQueryResult QueryUnapprovedCards(int nQueryByClassID,
                                           int lQueryByObjectID,
                                           boolean bShowAll,
                                           int lPropIDMask,
                                           int vOrderBy,
                                           int lSkipRows,
                                           int lMaxRows,
                                           java.lang.Object[][] vQueryFilter)
Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
Parameters:
lClassID - classID of the column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID
lObjectID - objectID of the column to select on
bShowAll - return all objects?
lPropIDMask - mask of propIDs to return
vOrderBy - propID to be sorted on
lSkipRows - number of rows to skip
lMaxRows - maximum number of rows to return
vQueryFilter - filter to be applied to the query
Returns:
IPTQueryResult of the documents being queried

QueryUnapprovedCards

public IPTQueryResult QueryUnapprovedCards(int nQueryByClassID,
                                           int lQueryByObjectID,
                                           boolean bShowAll,
                                           int lPropIDMask,
                                           java.lang.Object vOrderBy,
                                           int lSkipRows,
                                           int lMaxRows,
                                           java.lang.Object[][] vQueryFilter)
Queries and returns documents within a particular branch based on either the datasourceID, crawlerID, or documenttypeID.
Parameters:
lClassID - classID of the column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID
lObjectID - objectID of the column to select on
bShowAll - return all objects?
lPropIDMask - mask of propIDs to return
vOrderBy - propID to be sorted on
lSkipRows - number of rows to skip
lMaxRows - maximum number of rows to return
vQueryFilter - filter to be applied to the query
Returns:
IPTQueryResult of the documents being queried

QueryCardPaths

public IPTQueryResult QueryCardPaths(int vsaCardIDs,
                                     boolean bShowUnapproved,
                                     boolean bShowAllUnapproved)
Returns the document folders path of a document.
Parameters:
nCardID - cardID
bShowUnapproved - show unapproved documents?
bShowAllUnapproved - show all unapproved documents?
Returns:
IPTQueryResult containing PT_PROPID_OBJECTID, PT_PROPID_FOLDER_CARDAPPROVALSTAT, PT_PROPID_CARD_PARENTFOLDERID, and PT_PROPID_FOLDER_LEVEL;

QueryCardPaths

public IPTQueryResult QueryCardPaths(int[] vsaCardIDs,
                                     boolean bShowUnapproved,
                                     boolean bShowAllUnapproved)
Returns the document folders path of a set of documents.
Parameters:
vsaCardIDs - array of cardIDs
bShowUnapproved - show unapproved documents?
bShowAllUnapproved - show all unapproved documents?
Returns:
IPTQueryResult containing PT_PROPID_OBJECTID, PT_PROPID_FOLDER_CARDAPPROVALSTAT, PT_PROPID_CARD_PARENTFOLDERID, and PT_PROPID_FOLDER_LEVEL;

QueryFolderPaths

public IPTQueryResult QueryFolderPaths(int vsaFolderIDs)
Returns the folder path of a document folder.
Parameters:
vsaFolderIDs - folderID of the Folder
Returns:
and IPTQueryResult containing PT_PROPID_OBJECTID, PT_PROPID_FOLDER_LEVEL

QueryFolderPaths

public IPTQueryResult QueryFolderPaths(int[] vsaFolderIDs)
Returns the folder path of a set of document folders.
Parameters:
arFolderObjIDs - array of folderID of the Folders
Returns:
and IPTQueryResult containing PT_PROPID_OBJECTID, PT_PROPID_FOLDER_LEVEL

QueryCardAccess

public int QueryCardAccess(int nCardID)
Returns the access level that the current user has on the document.
Parameters:
nCardID - cardID of the document in question
Returns:
int access level that the current user has on the document

ApproveCardWhereUnapproved

public void ApproveCardWhereUnapproved(int lCardID)
Approves the documents in each of the Folders that document belongs to. Approve Access is required on these folders.
Parameters:
lCardID - cardID of the document being approved

DiscardCardWhereUnapproved

public void DiscardCardWhereUnapproved(int lCardID)
Discards documents from folders that denies the document access. The current user must have admin access on these folders.
Parameters:
lCardID - cardID of the document being discarded

SetApprovalStateByCard

public java.lang.Object[] SetApprovalStateByCard(int lCardID,
                                                 int nApprovalState,
                                                 java.lang.Object vsaFoldersToSetIn)
Sets the approval state of a document in a set of document folders.
Parameters:
lCardID - cardID of the document
nApprovalState - unapproved or pending approval?
vsaFolderIDs - int array of folders
Returns:
Object[] array of statuses

SetApprovalStateByFolder

public java.lang.Object[] SetApprovalStateByFolder(int lFolderID,
                                                   int nApprovalState,
                                                   java.lang.Object vsaCards)
Sets the approval state of multiple document in a single document folder.
Parameters:
lFolderID - folderID of the Folder
nApprovalState - unapproved or pending approval
vsaCards - int array of cardIDs of the documents
Returns:
Object[] array of statuses

CreateFolder

public IPTFolder CreateFolder(int lParentFolderID)
Creates a document folder. User must have the folder creation activity right and Edit access on the parent folder to do this.
Parameters:
lParentFolderID - parent folder id
Returns:
IPTFolder of the newly created folder

MoveFolder

public void MoveFolder(int lFolderID,
                       int lTargetFolderID)
Moves a document folder into another location. You cannot move a folder into itself or to any of its descendants. User needs Edit access on both the source and target folders, and Admin access on the Folder being moved.
Parameters:
lFolderID - folder id to move
lTargetFolderID - new location id

CopyFolder

public void CopyFolder(int lFolderID,
                       int lTargetFolderID,
                       boolean bRecursive,
                       boolean bCopyCards)
Copies the document folder. User must have the Folder creation activity right, and Edit access on the target folder.
Parameters:
lFolderID - folder ID to copy
lTargetFolderID - target folder id
bRecursive - copy subfolders?
bCopyCards - copy documents?

DeleteFolder

public void DeleteFolder(int lFolderID,
                         boolean bRecursive)
Deletes a document folder. User must have Admin access on the Folder being deleted.
Parameters:
lFolderID - folder id to delete
bRecursive - delete subfolders? will throw an error if this is false and there are subfolders

CreateCard

public IPTCard CreateCard()
Creates a blank document. This document is created in memory and is not serializied.
Returns:
IPTCard interface of a newly created blank document

AddMultipleCardsToFolder

public java.lang.Object[] AddMultipleCardsToFolder(int[] vsaCardIDs,
                                                   int lTargetFolderID,
                                                   int lRequestedApprovalState,
                                                   boolean bAddOnlyAtSpecifiedApprovalState)
Adds multiple documents to a single target document folder.
Parameters:
vsaCardIDs - array of cardIDs being added
lTargetFolderID - folderID of the Folder to which the documents are being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddMultipleCardsToFolder

public java.lang.Object[] AddMultipleCardsToFolder(int vsaCardIDs,
                                                   int lTargetFolderID,
                                                   int lRequestedApprovalState,
                                                   boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to a single target document folder.
Parameters:
nCardID - cardID being added
lTargetFolderID - folderID of the Folder to which the document is being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddCardToMultipleFolders

public java.lang.Object[] AddCardToMultipleFolders(int lCardID,
                                                   int[] vsaTargetFolderIDs,
                                                   int lRequestedApprovalState,
                                                   boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to multiple target document folders.
Parameters:
lCardID - cardID being added
vsaTargetFolderIDs - array folderIDs of the Folders to which the document are being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddCardToMultipleFolders

public java.lang.Object[] AddCardToMultipleFolders(int lCardID,
                                                   int vsaTargetFolderIDs,
                                                   int lRequestedApprovalState,
                                                   boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to a single target document folder.
Parameters:
lCardID - cardID being added
nTargetFolderID - folderID of the document folder to which the document is being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

MoveCards

public java.lang.Object[] MoveCards(int lFromFolderID,
                                    int[] vsaCardIDs,
                                    int lTargetFolderID,
                                    int lRequestedApprovalState,
                                    boolean bAddOnlyAtSpecifiedApprovalState)
Moves multiple document from a single document folder to another single document folder.
Parameters:
lFromFolderID - folderID of the Folder from which the document is being moved
vsaCardIDs - array of cardIDs of the Cards being moved
lTargetFolderID - folderID of the Folder to which the Card is being moved
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

MoveCards

public java.lang.Object[] MoveCards(int lFromFolderID,
                                    int vsaCardIDs,
                                    int lTargetFolderID,
                                    int lRequestedApprovalState,
                                    boolean bAddOnlyAtSpecifiedApprovalState)
Moves a single document from a single document folder to another single document folder.
Parameters:
lFromFolderID - folderID of the Folder from which the document is being moved
nCardID - cardID of the document being moved
lTargetFolderID - folderID of the Folder to which the document is being moved
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

RemoveCards

public java.lang.Object[] RemoveCards(int lFromFolderID,
                                      int[] vsaCardIDs)
Removes multiple documents from a single Folder.
Parameters:
lFromFolderID - folderID of the Folder containing the documents to be removed
vsaCardIDs - array of cardIDs of the documents being removed
Returns:
Object[] array of statuses

RemoveCards

public java.lang.Object[] RemoveCards(int lFromFolderID,
                                      int vsaCardIDs)
Removes a single document from a single document folder.
Parameters:
lFromFolderID - folderID of the Folder containing the document to be removed
nCardID - cardID of the document being removed
Returns:
Object[] array of statuses

DeleteCards

public java.lang.Object[] DeleteCards(int[] vsaCardIDs)
Deletes multiple documents from the catalog. User must have Admin access on the document and Edit access on the document folders of the document.
Parameters:
arObjectIDs - array of cardIDs of the documents being deleted
Returns:
Object[] array of statuses

DeleteCards

public java.lang.Object[] DeleteCards(int vsaCardIDs)
Deletes a single document from the knowledge directory.
Parameters:
nCardID - cardID of the document being deleted.
Returns:
array of statuses

AddMultipleCardsToFolderWithRank

public java.lang.Object[] AddMultipleCardsToFolderWithRank(int[] vsaCardIDs,
                                                           int[] vsaRankForEachCard,
                                                           int lTargetFolderID,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds multiple documents to a single target document folder with ranking.
Parameters:
vsaCardIDs - array of cardIDs of the documents being added
vsaRankForEachCard - rank assigned to each document for each folder
lTargetFolderID - folderID of the Folder to which the document is being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddMultipleCardsToFolderWithRank

public java.lang.Object[] AddMultipleCardsToFolderWithRank(int vsaCardIDs,
                                                           int vsaRankForEachCard,
                                                           int lTargetFolderID,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to a single target document folder with ranking.
Parameters:
nCardID - cardID of the document being added
nRankForEachCard - rank assigned to each document
lTargetFolderID - folderID of the Folder to which the document is being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddMultipleCardsToFolderWithRank

public java.lang.Object[] AddMultipleCardsToFolderWithRank(int vsaCardIDs,
                                                           int[] vsaRankForEachCard,
                                                           int lTargetFolderID,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to a single target document folder with ranking.
Parameters:
nCardID - cardID of the document being added
vsaRankForEachCard - rank assigned to each document for each folder
lTargetFolderID - folderID of the Folder to which the document is being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddMultipleCardsToFolderWithRank

public java.lang.Object[] AddMultipleCardsToFolderWithRank(int[] vsaCardIDs,
                                                           int vsaRankForEachCard,
                                                           int lTargetFolderID,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds multiple documents to a single target document folder with ranking.
Parameters:
vsaCardIDs - array of cardIDs of the documents being added
nRankForEachCard - rank assigned to each document
lTargetFolderID - folderID of the Folder to which the document is being added
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddCardToMultipleFoldersWithRank

public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
                                                           int[] vsaTargetFolderIDs,
                                                           int[] vsaRankInEachFolder,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to multiple target document folders with ranking.
Parameters:
lCardID - cardID being added
vsaTargetFolderIDs - array of folderIDs of the Folders to which the document are being added
vsaRankInEachFolder - array of ranks to be assigned to the documents in the target folders
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddCardToMultipleFoldersWithRank

public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
                                                           int vsaTargetFolderIDs,
                                                           int vsaRankInEachFolder,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to a single target document folder with ranking.
Parameters:
lCardID - cardID being added
nTargetFolderID - folderID of the Folder to which the document is being added
nRankInEachFolder - rank to be assigned to each document
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddCardToMultipleFoldersWithRank

public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
                                                           int vsaTargetFolderIDs,
                                                           int[] vsaRankInEachFolder,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to a single target document folder with ranking.
Parameters:
lCardID - cardID being added
nTargetFolderID - folderID of the Folder to which the document is being added
vsaRankInEachFolder - array of ranks to be assigned to the documents in the target folders
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

AddCardToMultipleFoldersWithRank

public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
                                                           int[] vsaTargetFolderIDs,
                                                           int vsaRankInEachFolder,
                                                           int lRequestedApprovalState,
                                                           boolean bAddOnlyAtSpecifiedApprovalState)
Adds a single document to multiple target document folders with ranking.
Parameters:
lCardID - cardID being added
vsaTargetFolderIDs - array of folderIDs of the Folders to which the document are being added
nRankInEachFolder - rank to be assigned to each document
lRequestedApprovalState - approved or pending approval
bAddOnlyAtSpecifiedApprovalState - does user need approve access?
Returns:
Object[] array of statuses

GetCardRank

public int GetCardRank(int lCardID,
                       int lFolderID)
Returns the ranking of a specific document in a specific document folder.
Parameters:
lCardID - cardID of the specific document
lFolderID - folderID of the specific Folder
Returns:
int the document's ranking

SetCardRank

public void SetCardRank(int lCardID,
                        int lFolderID,
                        int lRank)
Sets the ranking for a document in a particular document folder.
Parameters:
lCardID - cardID of the document
lFolderID - folderID where the document resides
lRank - rank to be assigned to the document

ClearRankFromAllCardsInFolder

public void ClearRankFromAllCardsInFolder(int lFolderID)
Clears the rank of all the documents within the specified document folder.
Parameters:
lFolderID - folderID of the Folder containing the documents

QueryCards

public IPTQueryResult QueryCards(int nQueryByClassID,
                                 int lQueryByObjectID,
                                 boolean bShowUnapproved,
                                 boolean bShowAllUnapproved,
                                 int lPropIDMask,
                                 int vOrderBy,
                                 int lSkipRows,
                                 int lMaxRows,
                                 java.lang.Object[][] vQueryFilter)
Returns an IPTQueryResult of documents based on datasourceID, crawlerID, or documenttypeID.
Parameters:
nQueryByClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID
lQueryByObjectID - objectID of the column to select on
bShowUnapproved - show unapproved documents?
bShowAllUnapproved - show all unapproved documents?
lPropIDMask - mask of propIDs to return
vOrderBy - propID to be sorted on
lSkipRows - number of rows to skip
lMaxRows - maximum number of rows to return
vQueryFilter - filter to be applied to the query
Returns:
IPTQueryResult of the documents being queried

QueryCards

public IPTQueryResult QueryCards(int nQueryByClassID,
                                 int lQueryByObjectID,
                                 boolean bShowUnapproved,
                                 boolean bShowAllUnapproved,
                                 int lPropIDMask,
                                 java.lang.Object vOrderBy,
                                 int lSkipRows,
                                 int lMaxRows,
                                 java.lang.Object[][] vQueryFilter)
Returns an IPTQueryResult of documents based on datasourceID, crawlerID, or documenttypeID.
Parameters:
nQueryByClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_ID
lQueryByObjectID - objectID of the column to select on
bShowUnapproved - show unapproved documents?
bShowAllUnapproved - show all unapproved documents?
lPropIDMask - mask of propIDs to return
vOrderBy - propID to be sorted on
lSkipRows - number of rows to skip
lMaxRows - maximum number of rows to return
vQueryFilter - filter to be applied to the query
Returns:
IPTQueryResult of the documents being queried

QueryFoldersByFilter

public IPTQueryResult QueryFoldersByFilter(int nFilterID)
Returns an IPTQueryResult of document folders that use a particular classification Filter.
Parameters:
nFilterID - filterID of the Filter
Returns:
IPTQueryResult of PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_DESCRIPTION, and PT_PROPID_ISLOCALIZED

QueryParentFolderIDs

public IPTQueryResult QueryParentFolderIDs(int nFolderID)
Returns a list of the parent folderIDs.
Parameters:
nFolderID - folderID of the Folder
Returns:
an IPTQueryResult consisting a one column of folderIDs

GetSearchServerStatus

public com.plumtree.openfoundation.util.IXPPropertyBag GetSearchServerStatus()
Returns the status of the query and failover search servers.
Returns:
IXPPropertyBag contains inner IXPPropertyBags of the statuses from the query and failover search servers

GenerateCardStatusReport

public com.plumtree.openfoundation.util.IXPPropertyBag GenerateCardStatusReport()
Queries the search index and database to generate a status report of the documents in the catalog
Returns:
IXPPropertyBag a collection of tallies

GetOrderByProperties

public IPTQueryResult GetOrderByProperties()
Returns the document properties by which documents by in a database query.
Returns:
IPTQueryResult containing OBJECTID, NAME, ISLOCALIZED

IsCatalogObjectAccessible

public boolean IsCatalogObjectAccessible(int lClassID,
                                         int lObjectID,
                                         int lMinAccessLevel)
Checks if current user has at least the lMinAccessLevel on either a specific document or folder.
Parameters:
lClassID - PT_CLASSIDS.PT_CATALOGCARD_ID or PT_CLASSIDS.PT_CATALOGFOLDER_ID
lObjectID - document/folder ID to check
lMinAccessLevel - min access level required (one of PT_ACCESS_LEVELS)
Returns:
boolean representing whether the object is accessible

GetCardSubmitDataSources

public IPTQueryResult GetCardSubmitDataSources(int lCardSubmitType)
Returns the DataSources that support the given document submission type.
Parameters:
lCardSubmitType - simple, advanced, or both
Returns:
IPTQueryResult collection of dataSourceIDs


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.