com.plumtree.server
Interface IPTDocumentTypeMap

All Superinterfaces:
IPTUnknown

public interface IPTDocumentTypeMap
extends IPTUnknown

Interface for IPTDocumentTypeMap


Method Summary
 void AddSection(int lSectionID)
          Adds a section to the mao
 void Clear()
          Clears the map.
 java.lang.Object[][] GetMappings(int lSectionID)
          Returns the mappings of a particular section
 IPTQueryResult GetSections()
          Returns all the sections currently in the map
 IPTDocumentType GetSuggestedDocumentType(int lSectionID, java.lang.String bstrDocumentIdentifier)
          Returns the suggested document type for a section and matched document identifier
 java.lang.Object[][] GetSuggestedIdentifiers(int lSectionID)
          Returns the identifiers for a section
 IPTQueryResult GetValidDocumentTypes(int lSectionID)
          Returns all the valid document types from a section
 void Initialize(IPTSession pSession)
          For DTMs inside Crawlers, this function will be called as the Crawler is being restored (in the CrawlerManager::OnOpen).
 int LookupByPropBag(com.plumtree.openfoundation.util.IXPPropertyBag vDocumentLocationBagAsXML)
          Returns the doc type id based on the prop bag passed in
 int LookupByPropBag(java.lang.String vDocumentLocationBagAsXML)
          Returns the doc type id based on the prop bag xml string passed in
 int LookupSuggested(int lSectionID, java.lang.String bstrDocumentIdentifier)
          Returns the doc type for a section id and matched document identifier.
 void RemoveSection(int lSectionID)
          Removes a section from the map
 void SetMappings(int lSectionID, java.lang.Object[][] pvsaMappings)
          Sets the mappings
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

Initialize

public void Initialize(IPTSession pSession)
For DTMs inside Crawlers, this function will be called as the Crawler is being restored (in the CrawlerManager::OnOpen). However, when the crawler is being created, it will actually be called twice, once by the OnOpen, and again when Initialize is called on the Crawler. And, it will be called when Perform Operation is called on the Crawler, with a different session.

AddSection

public void AddSection(int lSectionID)
Adds a section to the mao
Parameters:
lSectionID - section id to add

RemoveSection

public void RemoveSection(int lSectionID)
Removes a section from the map
Parameters:
lSectionID - section id to be removed

GetSections

public IPTQueryResult GetSections()
Returns all the sections currently in the map
Returns:
IPTQueryResult

GetValidDocumentTypes

public IPTQueryResult GetValidDocumentTypes(int lSectionID)
Returns all the valid document types from a section
Parameters:
lSectionID -  
Returns:
IPTQueryResult

GetSuggestedIdentifiers

public java.lang.Object[][] GetSuggestedIdentifiers(int lSectionID)
Returns the identifiers for a section
Parameters:
lSectionID -  
Returns:
Object[][]

GetMappings

public java.lang.Object[][] GetMappings(int lSectionID)
Returns the mappings of a particular section
Parameters:
lSectionID -  
Returns:
Object[][]

SetMappings

public void SetMappings(int lSectionID,
                        java.lang.Object[][] pvsaMappings)
Sets the mappings
Parameters:
lSectionID - section ID
pvsaMappings - mappings

LookupSuggested

public int LookupSuggested(int lSectionID,
                           java.lang.String bstrDocumentIdentifier)
Returns the doc type for a section id and matched document identifier.
Parameters:
lSectionID -  
bstrDocumentIdentifier -  
Returns:
int doc type id

LookupByPropBag

public int LookupByPropBag(java.lang.String vDocumentLocationBagAsXML)
Returns the doc type id based on the prop bag xml string passed in
Parameters:
vDocumentLocationBagAsXML - prop bag as xml string
Returns:
doc type id

LookupByPropBag

public int LookupByPropBag(com.plumtree.openfoundation.util.IXPPropertyBag vDocumentLocationBagAsXML)
Returns the doc type id based on the prop bag passed in
Parameters:
vDocumentLocationBagAsXML - prop bag
Returns:
doc type id

GetSuggestedDocumentType

public IPTDocumentType GetSuggestedDocumentType(int lSectionID,
                                                java.lang.String bstrDocumentIdentifier)
Returns the suggested document type for a section and matched document identifier
Parameters:
lSectionID -  
bstrDocumentIdentifier -  
Returns:
IPTDocumentType

Clear

public void Clear()
Clears the map.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.