com.ibm.portal.services.contentmapping
Interface ContentMapping

All Superinterfaces:

TimeStamped

public interface ContentMapping
extends TimeStamped

Objects of this class describe a mapping between a portal resource and a content resource. The content resource is identified either by its unique string identifier (e.g. JCR guid) or its absolute content path. Portal resources are identified via their ObjectID.

Individual content mappings can be grouped into scopes. A scope is identified by a simple string value. If no explicit scope value is provided, the mapping is considered part of the default scope.

Within each scope there can be zero or one mappings being declared default defining the default content resources being mapped to the given portal resource.

Content mappings can be retrieved using the ContentMappingLocator interface. New content mappings can be created and existing content mappings can be modified using the ContentMappingController interface. Both interfaces can be obtained from the ContentMappingInfoHome interface.

Since:

7.0.0.0

See Also:

ContentMappingLocator, ContentMappingInfoController, ContentMappingInfoHome, ObjectID

Method Summary

java.lang.String	getContentID() Returns the content ID for this mapping.
java.lang.String	getContentPath() Returns the content path for this mapping.
ObjectID	getResourceID() Returns the portal resource ID for this mapping.
java.lang.String	getScope() Returns the scope value for this content mapping.
boolean	isDefault() Returns true if and only if, this content mapping is flagged as being the default mapping within the scope assigned to this content mapping
boolean	isDelegating() Returns true if and only if, this content mapping is flagged as activating access control delegation
boolean	isSystem() Returns true if and only if, this content mapping is flagged as system mapping.

Methods inherited from interface com.ibm.portal.TimeStamped

getCreated, getLastModified

Method Detail

getResourceID

ObjectID getResourceID()

Returns the portal resource ID for this mapping. This method never returns null.

getContentID

java.lang.String getContentID()

Returns the content ID for this mapping. This returns null if and only if the resource is identified by a content path instead of by content ID

getContentPath

java.lang.String getContentPath()

Returns the content path for this mapping. This method returns null if and only if the resource is currently identified by content ID instead of by content path.

getScope

java.lang.String getScope()

Returns the scope value for this content mapping. This method returns null if and only if the mapping was not explicitly assigned to a scope, meaning the mapping is considered part of the default scope.

isDefault

boolean isDefault()

Returns true if and only if, this content mapping is flagged as being the default mapping within the scope assigned to this content mapping

isSystem

boolean isSystem()

Returns true if and only if, this content mapping is flagged as system mapping.

isDelegating

boolean isDelegating()

Returns true if and only if, this content mapping is flagged as activating access control delegation

See Also:

ContentMappingDelegationService