com.ibm.portal.services.contentmapping
Interface ContentMappingInfo

All Known Subinterfaces:

ModifiableContentMappingInfo

public interface ContentMappingInfo

This interface provides access to all content mappings assigned to a specific portal resource. The ObjectID of this portlet resource can be obtained via the the getResourceOID() method. An instance of this interface for a specific portal resource can be obtained using the ContentMappingInfoHome interface.

Since:

7.0.0.0

See Also:

ContentMappingInfoHome

Method Summary

java.util.List<ContentMapping>	getContentMappings() Returns the list of all individual content mappings assigned to this resource.
java.util.List<ContentMapping>	getContentMappings(boolean sortByPath) Returns the list of all individual content mappings assigned to this resource.
java.util.List<ContentMapping>	getContentMappings(java.lang.String scope) Returns the individual content mappings assigned to this resource for a given content mapping scope.
java.util.List<ContentMapping>	getContentMappings(java.lang.String scope, boolean sortByPath) Returns the individual content mappings assigned to this resource for a given content mapping scope.
ContentMapping	getDefaultContentMapping() Returns the default content mapping for the default scope.
ContentMapping	getDefaultContentMapping(java.lang.String scope) Returns the default content mapping for a given scope.
ObjectID	getResourceOID() Returns the portal resource ObjectID for this ContentMappingInfo object.
java.util.Set<java.lang.String>	getScopes() Returns an unmodifiable set of scopes used by this ContentMappingInfo object.
ContentMapping	getSystemContentMapping() Returns the system mapping for the default scope.
ContentMapping	getSystemContentMapping(java.lang.String scope) Returns the system mapping for a given scope.
boolean	isEmpty() Returns true if and only if there are no content mappings assigned to the given portal resource.

Method Detail

getResourceOID

ObjectID getResourceOID()

Returns the portal resource ObjectID for this ContentMappingInfo object.

getContentMappings

java.util.List<ContentMapping> getContentMappings()

Returns the list of all individual content mappings assigned to this resource. The list is unmodifiable and does not include duplicate entries. This method never returns null. If there are no content mappings, an empty list is returned.

getContentMappings

java.util.List<ContentMapping> getContentMappings(boolean sortByPath)

Returns the list of all individual content mappings assigned to this resource. The list is unmodifiable and does not include duplicate entries. If the parameter sortByPath is set to true, the list is sorted by the content mappings path, otherwise the list is unsorted. This method never returns null. If there are no content mappings, an empty list is returned.

Parameters:

sortByPath - if set to true, the list is sorted by the content mappings path, otherwise the list is unsorted.

getContentMappings

java.util.List<ContentMapping> getContentMappings(java.lang.String scope)

Returns the individual content mappings assigned to this resource for a given content mapping scope. The list is unmodifiable and does not include duplicate entries. This method never returns null. If there are no content mappings in the given scope, an empty list is returned.

Parameters:

scope - The scope

getContentMappings

java.util.List<ContentMapping> getContentMappings(java.lang.String scope,
                                                  boolean sortByPath)

Returns the individual content mappings assigned to this resource for a given content mapping scope. The list is unmodifiable and does not include duplicate entries. If the parameter sortByPath is set to true, the list is sorted by the content mappings path, otherwise the list is unsorted. This method never returns null. If there are no content mappings in the given scope, an empty list is returned.

Parameters:

scope - The scope

sortByPath - if set to true, the list is sorted by the content mappings path, otherwise the list is unsorted.

getDefaultContentMapping

ContentMapping getDefaultContentMapping()

Returns the default content mapping for the default scope. This method returns null if no such mapping exists.

getSystemContentMapping

ContentMapping getSystemContentMapping()

Returns the system mapping for the default scope. This method returns null if no such mapping exists.

getDefaultContentMapping

ContentMapping getDefaultContentMapping(java.lang.String scope)

Returns the default content mapping for a given scope. This method returns null if no such mapping exists.

Parameters:

scope - The scope

getSystemContentMapping

ContentMapping getSystemContentMapping(java.lang.String scope)

Returns the system mapping for a given scope. This method returns null if no such mapping exists.

Parameters:

scope - The scope

getScopes

java.util.Set<java.lang.String> getScopes()

Returns an unmodifiable set of scopes used by this ContentMappingInfo object. This method never returns null. If there are no scopes defined, an empty set is returned.

isEmpty

boolean isEmpty()

Returns true if and only if there are no content mappings assigned to the given portal resource.