Aqualogic Interaction API  
 

IPTCatalog Members

IPTCatalog overview

Public Instance Methods

AddCardToMultipleFoldersOverloaded. Adds a single document to multiple target document folders.
AddCardToMultipleFoldersWithRankOverloaded. Adds a single document to multiple target document folders with ranking.
AddMultipleCardsToFolderOverloaded. Adds multiple documents to a single target document folder.
AddMultipleCardsToFolderWithRankOverloaded. Adds multiple documents to a single target document folder with ranking.
ApproveCardWhereUnapproved 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.
ClearRankFromAllCardsInFolder Clears the rank of all the documents within the specified document folder.
CopyFolder 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.
CreateCard Creates a blank document. This document is created in memory and is not serialized.
CreateFolder 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.
DeleteCardsOverloaded. 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.
DeleteFolder Deletes a document folder. User must have admin access privilege (full administrative control) for the document folder being deleted.
DiscardCardWhereUnapproved 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.
FlushNameFromObjectIdLookupCache Clears the object id lookup cache. Only use for automated tests.
GenerateCardStatusReport Queries the search index and database to generate a status report of the documents in the Knowledge Directory (Catalog).
GetCardRank Returns the ranking of a specific document in a specific document folder.
GetCardSubmitDataSources Returns the DataSources that support the given document submission type.
GetOrderByProperties Returns the document properties that a document can be ordered by in a database query.
GetRootFolder Returns the root folder.
GetSearchServerStatus Returns the status of the query and failover search servers.
GetSettings 
GetStatistics Returns IPTCatalogStatistics, which is the interface for determining document popularity statistics.
GetUnclassifiedCardsFolder Returns the Unclassified Cards folder.
IsCatalogObjectAccessible Checks if current user has at least the minimum access level for a specific document or folder.
LookupNameFromObjectId Looks up the priamry name of the object with the specified id.
LookupObjectIdFromName Looks up the id (or ids if there are more than one) of the objects with the specified name.
MoveCardsOverloaded. Moves multiple documents from a single document folder to another single document folder.
MoveFolder 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.
OpenCard Retrieves an existing document.
OpenFolder Retrieves a document folder. To lock an object, user needs at least edit access privilege (permission to modify folders) for the folder.
OpenFolderByPath Retrieves a document folder. To lock an object, the user needs at least edit access privilege (permission to modify folders) for the document folder.
QueryCardAccess Returns the access level of the current user for the document.
QueryCardIsVisible Returns whether or not the current user can see the requested card, if the card exists.
QueryCardPathsOverloaded. Returns the document folders path of a document.
QueryCardsOverloaded. Returns an IPTQueryResult of documents based on datasourceID, crawlerID, or documenttypeID.
QueryFolderPathsOverloaded. Returns the folder path of a document folder.
QueryFoldersByFilter 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.
QueryParentFolderIDs Returns a list of the parent folderIDs.
QueryUnapprovedCardsOverloaded. Queries and returns documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
QueryUnapprovedCardsByBranchOverloaded. Queries and returns unapproved documents within a particular document folder branch based on the datasourceID, crawlerID, or documenttypeID.
QueryUnapprovedCardsCount Returns the number of unapproved documents based on datasourceID, crawlerID, or documenttypeID.
QueryUnapprovedCardsCountByBranch Returns the number of documents within a particular branch of the Knowledge Directory (Catalog).
QueryUnapprovedCardsCountGlobal Returns the total number of documents in the Knowledge Directory (Catalog).
RemoveCardsOverloaded. Removes multiple documents from a single document folder.
SetApprovalStateByCard Sets the approval state of a document in a set of selected document folders.
SetApprovalStateByFolder Sets the approval state of multiple documents in a single document folder.
SetCardRank Sets the ranking for a document in a particular document folder.
SetSettings 

See Also

IPTCatalog Interface | com.plumtree.server Namespace