WebCenter Interaction API  
 

IPTCatalog Members

IPTCatalog overview

Public Instance Methods

public methodAddCardToMultipleFoldersOverloaded. Adds a single document to multiple target document folders.
public methodAddCardToMultipleFoldersWithRankOverloaded. Adds a single document to multiple target document folders with ranking.
public methodAddMultipleCardsToFolderOverloaded. Adds multiple documents to a single target document folder.
public methodAddMultipleCardsToFolderWithRankOverloaded. Adds multiple documents to a single target document folder with ranking.
public methodApproveCardWhereUnapproved Approves every copy of the document in every document folders that it resides in. The approval propagates across all folders that contain the document, so the user must have admin access privilege (permission to modify folders) for these folders.
public methodClearRankFromAllCardsInFolder Clears the rank of all the documents within the specified document folder.
public methodCopyFolder Copies the document folder. The user must have the folder creation activity rights (permission to create folders) and edit access privilege (permission to modify folders) for the target folder.
public methodCreateCard Creates a blank document. This document is created in memory and is not serialized.
public methodCreateFolder Creates a document folder. The user must have folder creation activity rights (permission to create folders) and edit access privilege (permission to modify folders) for the parent folder.
public methodDeleteCardsOverloaded. Deletes multiple documents from the Knowledge Directory (Catalog). The user must have admin access privilege (full administrative control) for the documents and edit access privilege (permission to modify folders) for the document folders of the document.
public methodDeleteFolder Deletes a document folder. User must have admin access privilege (full administrative control) for the document folder being deleted.
public methodDiscardCardWhereUnapproved Discards unapproved documents from folders that do not allow document access. The same document will not be discarded in folders that allow document access. The current user must have admin access privilege (full control rights) on these folders to discard unapproved documents.
public methodFlushNameFromObjectIdLookupCache Clears the object id lookup cache. Only use for automated tests.
public methodGenerateCardStatusReport Queries the search index and database to generate a status report of the documents in the Knowledge Directory (Catalog).
public methodGetCardRank Returns the ranking of a specific document in a specific document folder.
public methodGetCardSubmitDataSources Returns the DataSources that support the given document submission type.
public methodGetOrderByProperties Returns the document properties that a document can be ordered by in a database query.
public methodGetRootFolder Returns the root folder.
public methodGetSearchServerStatus Returns the status of the query and failover search servers.
public methodGetSettings 
public methodGetStatistics Returns IPTCatalogStatistics, which is the interface for determining document popularity statistics.
public methodGetUnclassifiedCardsFolder Returns the Unclassified Cards folder.
public methodIsCatalogObjectAccessible Checks if current user has at least the minimum access level for a specific document or folder.
public methodLookupNameFromObjectId Looks up the priamry name of the object with the specified id.
public methodLookupObjectIdFromName Looks up the id (or ids if there are more than one) of the objects with the specified name.
public methodMoveCardsOverloaded. Moves multiple documents from a single document folder to another single document folder.
public methodMoveFolder Moves a document folder into another location. You cannot move a folder into itself or to any of its descendants. The user needs edit access privilege (permission to modify folders) for both the source and target folders, and admin access privilege (full administrative control) for the document folder being moved.
public methodOpenCard Retrieves an existing document.
public methodOpenFolder Retrieves a document folder. To lock an object, user needs at least edit access privilege (permission to modify folders) for the folder.
public methodOpenFolderByPath Retrieves a document folder. To lock an object, the user needs at least edit access privilege (permission to modify folders) for the document folder.
public methodQueryCardAccess Returns the access level of the current user for the document.
public methodQueryCardIsVisible Returns whether or not the current user can see the requested card, if the card exists.
public methodQueryCardPathsOverloaded. Returns the document folders path of a document.
public methodQueryCardsOverloaded. Returns an IPTQueryResult of documents based on datasourceID, crawlerID, or documenttypeID.
public methodQueryFolderPathsOverloaded. Returns the folder path of a document folder.
public methodQueryFoldersByFilter Returns an IPTQueryResult of document folders that use a particular classification Filter. Filters can be assigned to multiple folders. This returns which folders have filters mapped to them.
public methodQueryParentFolderIDs Returns a list of the parent folderIDs.
public methodQueryUnapprovedCardsOverloaded. Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
public methodQueryUnapprovedCardsByBranchOverloaded. Queries and returns unapproved documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
public methodQueryUnapprovedCardsCount Returns the number of unapproved documents based on datasourceID, crawlerID, or documenttypeID.
public methodQueryUnapprovedCardsCountByBranch Returns the number of documents within a particular branch of the Knowledge Directory (Catalog).
public methodQueryUnapprovedCardsCountGlobal Returns the total number of documents in the Knowledge Directory (Catalog).
public methodRemoveCardsOverloaded. Removes multiple documents from a single document folder.
public methodSetApprovalStateByCard Sets the approval state of a document in a set of selected document folders.
public methodSetApprovalStateByFolder Sets the approval state of multiple documents in a single document folder.
public methodSetCardRank Sets the ranking for a document in a particular document folder.
public methodSetSettings 

See Also

IPTCatalog Interface | com.plumtree.server Namespace