|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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 |
public IPTFolder GetRootFolder()
public IPTFolder GetUnclassifiedCardsFolder()
public IPTCatalogStatistics GetStatistics()
public void SetSettings(int Value,
java.lang.Object pvValue)
public java.lang.Object GetSettings(int lSettings)
public IPTFolder OpenFolder(int lFolderID,
boolean bLockOnOpen)
lFolderID - document folder ID to retrieve.bLockOnOpen - if true, locks the object.
public IPTFolder OpenFolderByPath(java.lang.String bstrFolderPath,
boolean bLockOnOpen)
bstrFolderPath - path of the document folder.bLockOnOpen - lock it?
public IPTCard OpenCard(int lCardID,
boolean bLockOnOpen)
lCardID - cardID of the document being opened.bLockOnOpen - if true, locks the document.public int QueryUnapprovedCardsCountGlobal(boolean bShowAll)
bShowAll - if true, returns the total number of unapproved documents, including ones user has no access rights to.
public int QueryUnapprovedCardsCountByBranch(int lFolderID,
boolean bShowAll)
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.
public IPTQueryResult QueryUnapprovedCardsByBranch(int lFolderID,
boolean bShowAll,
int lPropIDMask,
int vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
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 returnvOrderBy - propID to be sorted onlSkipRows - number of rows to skip.lMaxRows - maximum number of rows to return.vQueryFilter - filter to be applied to the query.
public IPTQueryResult QueryUnapprovedCardsByBranch(int lFolderID,
boolean bShowAll,
int lPropIDMask,
java.lang.Object vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
lClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_IDlObjectID - objectID of the column to select onbShowAll - return all objects?lPropIDMask - mask of propIDs to returnvOrderBy - propID to be sorted onlSkipRows - number of rows to skiplMaxRows - maximum number of rows to returnvQueryFilter - filter to be applied to the query
public int QueryUnapprovedCardsCount(int nQueryByClassID,
int lQueryByObjectID,
boolean bShowAll)
nQueryByClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_IDlQueryByObjectID - objectID of the column to select onbShowAll - return all objects?
public IPTQueryResult QueryUnapprovedCards(int nQueryByClassID,
int lQueryByObjectID,
boolean bShowAll,
int lPropIDMask,
int vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
lClassID - classID of the column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_IDlObjectID - objectID of the column to select onbShowAll - return all objects?lPropIDMask - mask of propIDs to returnvOrderBy - propID to be sorted onlSkipRows - number of rows to skiplMaxRows - maximum number of rows to returnvQueryFilter - filter to be applied to the query
public IPTQueryResult QueryUnapprovedCards(int nQueryByClassID,
int lQueryByObjectID,
boolean bShowAll,
int lPropIDMask,
java.lang.Object vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
lClassID - classID of the column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_IDlObjectID - objectID of the column to select onbShowAll - return all objects?lPropIDMask - mask of propIDs to returnvOrderBy - propID to be sorted onlSkipRows - number of rows to skiplMaxRows - maximum number of rows to returnvQueryFilter - filter to be applied to the query
public IPTQueryResult QueryCardPaths(int vsaCardIDs,
boolean bShowUnapproved,
boolean bShowAllUnapproved)
nCardID - cardIDbShowUnapproved - show unapproved documents?bShowAllUnapproved - show all unapproved documents?
public IPTQueryResult QueryCardPaths(int[] vsaCardIDs,
boolean bShowUnapproved,
boolean bShowAllUnapproved)
vsaCardIDs - array of cardIDsbShowUnapproved - show unapproved documents?bShowAllUnapproved - show all unapproved documents?public IPTQueryResult QueryFolderPaths(int vsaFolderIDs)
vsaFolderIDs - folderID of the Folderpublic IPTQueryResult QueryFolderPaths(int[] vsaFolderIDs)
arFolderObjIDs - array of folderID of the Folderspublic int QueryCardAccess(int nCardID)
nCardID - cardID of the document in questionpublic void ApproveCardWhereUnapproved(int lCardID)
lCardID - cardID of the document being approvedpublic void DiscardCardWhereUnapproved(int lCardID)
lCardID - cardID of the document being discarded
public java.lang.Object[] SetApprovalStateByCard(int lCardID,
int nApprovalState,
java.lang.Object vsaFoldersToSetIn)
lCardID - cardID of the documentnApprovalState - unapproved or pending approval?vsaFolderIDs - int array of folders
public java.lang.Object[] SetApprovalStateByFolder(int lFolderID,
int nApprovalState,
java.lang.Object vsaCards)
lFolderID - folderID of the FoldernApprovalState - unapproved or pending approvalvsaCards - int array of cardIDs of the documentspublic IPTFolder CreateFolder(int lParentFolderID)
lParentFolderID - parent folder id
public void MoveFolder(int lFolderID,
int lTargetFolderID)
lFolderID - folder id to movelTargetFolderID - new location id
public void CopyFolder(int lFolderID,
int lTargetFolderID,
boolean bRecursive,
boolean bCopyCards)
lFolderID - folder ID to copylTargetFolderID - target folder idbRecursive - copy subfolders?bCopyCards - copy documents?
public void DeleteFolder(int lFolderID,
boolean bRecursive)
lFolderID - folder id to deletebRecursive - delete subfolders? will throw an error if this is false
and there are subfolderspublic IPTCard CreateCard()
public java.lang.Object[] AddMultipleCardsToFolder(int[] vsaCardIDs,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
vsaCardIDs - array of cardIDs being addedlTargetFolderID - folderID of the Folder to which the documents are being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddMultipleCardsToFolder(int vsaCardIDs,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
nCardID - cardID being addedlTargetFolderID - folderID of the Folder to which the document is being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddCardToMultipleFolders(int lCardID,
int[] vsaTargetFolderIDs,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lCardID - cardID being addedvsaTargetFolderIDs - array folderIDs of the Folders to which the document are being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddCardToMultipleFolders(int lCardID,
int vsaTargetFolderIDs,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lCardID - cardID being addednTargetFolderID - folderID of the document folder to which the document is being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] MoveCards(int lFromFolderID,
int[] vsaCardIDs,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lFromFolderID - folderID of the Folder from which the document is being movedvsaCardIDs - array of cardIDs of the Cards being movedlTargetFolderID - folderID of the Folder to which the Card is being movedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] MoveCards(int lFromFolderID,
int vsaCardIDs,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lFromFolderID - folderID of the Folder from which the document is being movednCardID - cardID of the document being movedlTargetFolderID - folderID of the Folder to which the document is being movedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] RemoveCards(int lFromFolderID,
int[] vsaCardIDs)
lFromFolderID - folderID of the Folder containing the documents to be removedvsaCardIDs - array of cardIDs of the documents being removed
public java.lang.Object[] RemoveCards(int lFromFolderID,
int vsaCardIDs)
lFromFolderID - folderID of the Folder containing the document to be removednCardID - cardID of the document being removedpublic java.lang.Object[] DeleteCards(int[] vsaCardIDs)
arObjectIDs - array of cardIDs of the documents being deletedpublic java.lang.Object[] DeleteCards(int vsaCardIDs)
nCardID - cardID of the document being deleted.
public java.lang.Object[] AddMultipleCardsToFolderWithRank(int[] vsaCardIDs,
int[] vsaRankForEachCard,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
vsaCardIDs - array of cardIDs of the documents being addedvsaRankForEachCard - rank assigned to each document for each folderlTargetFolderID - folderID of the Folder to which the document is being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddMultipleCardsToFolderWithRank(int vsaCardIDs,
int vsaRankForEachCard,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
nCardID - cardID of the document being addednRankForEachCard - rank assigned to each documentlTargetFolderID - folderID of the Folder to which the document is being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddMultipleCardsToFolderWithRank(int vsaCardIDs,
int[] vsaRankForEachCard,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
nCardID - cardID of the document being addedvsaRankForEachCard - rank assigned to each document for each folderlTargetFolderID - folderID of the Folder to which the document is being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddMultipleCardsToFolderWithRank(int[] vsaCardIDs,
int vsaRankForEachCard,
int lTargetFolderID,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
vsaCardIDs - array of cardIDs of the documents being addednRankForEachCard - rank assigned to each documentlTargetFolderID - folderID of the Folder to which the document is being addedlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
int[] vsaTargetFolderIDs,
int[] vsaRankInEachFolder,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lCardID - cardID being addedvsaTargetFolderIDs - array of folderIDs of the Folders to which the document are being addedvsaRankInEachFolder - array of ranks to be assigned to the documents in the target folderslRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
int vsaTargetFolderIDs,
int vsaRankInEachFolder,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lCardID - cardID being addednTargetFolderID - folderID of the Folder to which the document is being addednRankInEachFolder - rank to be assigned to each documentlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
int vsaTargetFolderIDs,
int[] vsaRankInEachFolder,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lCardID - cardID being addednTargetFolderID - folderID of the Folder to which the document is being addedvsaRankInEachFolder - array of ranks to be assigned to the documents in the target folderslRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public java.lang.Object[] AddCardToMultipleFoldersWithRank(int lCardID,
int[] vsaTargetFolderIDs,
int vsaRankInEachFolder,
int lRequestedApprovalState,
boolean bAddOnlyAtSpecifiedApprovalState)
lCardID - cardID being addedvsaTargetFolderIDs - array of folderIDs of the Folders to which the document are being addednRankInEachFolder - rank to be assigned to each documentlRequestedApprovalState - approved or pending approvalbAddOnlyAtSpecifiedApprovalState - does user need approve access?
public int GetCardRank(int lCardID,
int lFolderID)
lCardID - cardID of the specific documentlFolderID - folderID of the specific Folder
public void SetCardRank(int lCardID,
int lFolderID,
int lRank)
lCardID - cardID of the documentlFolderID - folderID where the document resideslRank - rank to be assigned to the documentpublic void ClearRankFromAllCardsInFolder(int lFolderID)
lFolderID - folderID of the Folder containing the documents
public IPTQueryResult QueryCards(int nQueryByClassID,
int lQueryByObjectID,
boolean bShowUnapproved,
boolean bShowAllUnapproved,
int lPropIDMask,
int vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
nQueryByClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_IDlQueryByObjectID - objectID of the column to select onbShowUnapproved - show unapproved documents?bShowAllUnapproved - show all unapproved documents?lPropIDMask - mask of propIDs to returnvOrderBy - propID to be sorted onlSkipRows - number of rows to skiplMaxRows - maximum number of rows to returnvQueryFilter - filter to be applied to the query
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)
nQueryByClassID - column to select on: either PT_DATASOURCE_ID, PT_CRAWLER_ID, or PT_DOCUMENTTYPE_IDlQueryByObjectID - objectID of the column to select onbShowUnapproved - show unapproved documents?bShowAllUnapproved - show all unapproved documents?lPropIDMask - mask of propIDs to returnvOrderBy - propID to be sorted onlSkipRows - number of rows to skiplMaxRows - maximum number of rows to returnvQueryFilter - filter to be applied to the querypublic IPTQueryResult QueryFoldersByFilter(int nFilterID)
nFilterID - filterID of the Filterpublic IPTQueryResult QueryParentFolderIDs(int nFolderID)
nFolderID - folderID of the Folderpublic com.plumtree.openfoundation.util.IXPPropertyBag GetSearchServerStatus()
public com.plumtree.openfoundation.util.IXPPropertyBag GenerateCardStatusReport()
public IPTQueryResult GetOrderByProperties()
public boolean IsCatalogObjectAccessible(int lClassID,
int lObjectID,
int lMinAccessLevel)
lClassID - PT_CLASSIDS.PT_CATALOGCARD_ID or PT_CLASSIDS.PT_CATALOGFOLDER_IDlObjectID - document/folder ID to checklMinAccessLevel - min access level required (one of PT_ACCESS_LEVELS)public IPTQueryResult GetCardSubmitDataSources(int lCardSubmitType)
lCardSubmitType - simple, advanced, or both
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||