Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.services.contentmapping
Interface ContentMappingLocator
public interface ContentMappingLocatorThis interface can be used for searching specific content mappings based on various filter criteria. This interface is thread safe and can be cached. An instance of this interface can be obtained via the ContentMappingInfoHome interface.
- Since:
- 7.0.0.0
- See Also:
- ContentMappingInfoHome
Method Summary IterableListModel<ContentMapping> findContentMappingsByContentId(java.lang.String contentId)
Return all content mappings mapped directly to a given content ID.IterableListModel<ContentMapping> findContentMappingsByContentPath(java.lang.String contentPath)
Return all content mappings mapped directly to a given content path value (no path prefix matching is performed).ContentMapping findSystemContentMappingByContentID(java.lang.String contentId)
Return the system content mapping mapped directly to a given content ID.ContentMapping findSystemContentMappingByContentPath(java.lang.String contentPath)
Return the system content mapping mapped directly to a given content path value (no path prefix matching is performed).LongestPathMatch getLongestPathMatch(java.util.List<java.lang.String> contentPathElementIDs, Identifiable currentResource)
This method locates content mappings based on a specific content resource.LongestPathMatch getLongestPathMatch(java.util.List<java.lang.String> contentPathElementIDs, Identifiable currentResource, ContentMappingFilter filter)
This method locates content mappings based on a specific content resource.
Method Detail getLongestPathMatch
LongestPathMatch getLongestPathMatch(java.util.List<java.lang.String> contentPathElementIDs, Identifiable currentResource) throws ContentMappingException
- This method locates content mappings based on a specific content resource.
- Parameters:
- contentPathElementIDs - The ordered list of content ID values identifying the content resources contained in the path from the resource's content root resource to the resource.
- currentResource - The current users currently selected portal resource. This parameter may be null.
- Returns:
- The LongestPathMatch object containing the match result. This method never returns null.
- Throws:
- ContentMappingException
- See Also:
- ContentMappingLocator#findContentMappingByLongestPathMatch(String, List, Identifiable)
getLongestPathMatch
LongestPathMatch getLongestPathMatch(java.util.List<java.lang.String> contentPathElementIDs, Identifiable currentResource, ContentMappingFilter filter) throws ContentMappingException
- This method locates content mappings based on a specific content resource.
- Parameters:
- contentPathElementIDs - The ordered list of content ID values identifying the content resources contained in the path from the resource's content root resource to the resource.
- currentResource - The current users currently selected portal resource. This parameter may be null.
- filter - A ContentMappingFilter to filter the mappings that map to a page which is visible to the current user.
- Returns:
- The LongestPathMatch object containing the match result. This method never returns null.
- Throws:
- ContentMappingException
- See Also:
- ContentMappingLocator#findContentMappingByLongestPathMatch(String, List, Identifiable)
findContentMappingsByContentPath
IterableListModel<ContentMapping> findContentMappingsByContentPath(java.lang.String contentPath) throws ContentMappingDataBackendException
- Returns all content mappings mapped directly to a given content path value (no path prefix matching is performed). This method never returns null
- Parameters:
- contentPath - The path to the content resource.
- Throws:
- ContentMappingDataBackendException
findContentMappingsByContentId
IterableListModel<ContentMapping> findContentMappingsByContentId(java.lang.String contentId) throws ContentMappingDataBackendException
- Returns all content mappings mapped directly to a given content ID. This method never returns null.
- Parameters:
- contentId - The ID of the content resource.
- Throws:
- ContentMappingDataBackendException
findSystemContentMappingByContentID
ContentMapping findSystemContentMappingByContentID(java.lang.String contentId) throws ContentMappingDataBackendException
- Returns the system content mapping mapped directly to a given content ID. This method may return null.
- Parameters:
- contentId - The ID of the content resource.
- Returns:
- the system mapping, if one could be found, otherwise it will return null.
- Throws:
- ContentMappingDataBackendException - the content mapping data backend exception
findSystemContentMappingByContentPath
ContentMapping findSystemContentMappingByContentPath(java.lang.String contentPath) throws ContentMappingDataBackendException
- Returns the system content mapping mapped directly to a given content path value (no path prefix matching is performed). This method may return null.
- Parameters:
- contentPath - The path of the content resource.
- Returns:
- the system mapping, if one could be found, otherwise it will return null.
- Throws:
- ContentMappingDataBackendException - the content mapping data backend exception
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD