Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.services.contentmapping
Interface ModifiableContentMappingInfo
- All Superinterfaces:
- ContentMappingInfo
public interface ModifiableContentMappingInfo- extends ContentMappingInfo
This interface allows to modify the content mapping information associated to a given portal resource. The ModifiableContentMappingInfo instance can be obtained for a specific portal resource using the ContentMappingInfoController interface. Any updates to the ModifiableContentMappingInfo instance are not persisted until the ContentMappingInfoController instance used to create a given ModifiableContentMappingInfo is committed by calling its commit() method. ModifiableContentMappingInfo instances are not thread safe and cannot be committed twice.
- Since:
- 7.0.0.0
- See Also:
- ContentMappingInfoController
Method Summary void addContentID(java.lang.String contentId, boolean isDefault, java.lang.String scope)
Adds a (non-delegating) mapping to a content object which is identified via its content ID.void addContentID(java.lang.String contentId, boolean isDefault, java.lang.String scope, boolean isDelegating)
Adds a mapping to a content object which is identified via its content ID.void addContentID(java.lang.String contentId, boolean isDefault, java.lang.String scope, boolean isDelegating, Identifiable contentProxyResource)
Adds a mapping to a content object which is identified via its content ID.void addContentPath(java.lang.String contentPath, boolean isDefault, java.lang.String scope)
Adds a (non-delegating) mapping to a content object which is identified via its content path.void addContentPath(java.lang.String contentPath, boolean isDefault, java.lang.String scope, boolean isDelegating)
Adds a mapping to a content object which is identified via its content path.void addContentPath(java.lang.String contentPath, boolean isDefault, java.lang.String scope, boolean isDelegating, Identifiable contentProxyResource)
Adds a mapping to a content object which is identified via its content path.void removeContentID(java.lang.String contentId)
Removes a content mapping identified by its content ID.void removeContentID(java.lang.String contentId, Identifiable contentProxyResource)
Removes a content mapping identified by its content ID.void removeContentPath(java.lang.String contentPath)
Removes a content mapping identified by its content path.void removeContentPath(java.lang.String contentPath, Identifiable contentProxyResource)
Removes a content mapping identified by its content path.void setDefaultByContentID(java.lang.String contentId, boolean isDefault)
Sets the default content flag for an existing mapping identified by its content ID.void setDefaultByContentPath(java.lang.String contentPath, boolean isDefault)
Sets the default content flag for an existing mapping identified by its content path.void setDelegatingByContentID(java.lang.String contentId, boolean isDelegating)
Sets the access control delegation flag for an existing mapping identified by its content ID.void setDelegatingByContentID(java.lang.String contentId, boolean isDelegating, Identifiable contentProxyResource)
Sets the access control delegation flag for an existing mapping identified by its content ID.void setDelegatingByContentPath(java.lang.String contentPath, boolean isDelegating)
Sets the access control delegation flag for an existing mapping identified by its content path.void setDelegatingByContentPath(java.lang.String contentPath, boolean isDelegating, Identifiable contentProxyResource)
Sets the access control delegation flag for an existing mapping identified by its content path.void setScopeByContentID(java.lang.String contentId, java.lang.String scope)
Sets the scope for an existing mapping identified by its content ID.void setScopeByContentPath(java.lang.String contentPath, java.lang.String scope)
Sets the scope for an existing mapping identified by its content path.
Methods inherited from interface com.ibm.portal.services.contentmapping.ContentMappingInfo getContentMappings, getContentMappings, getContentMappings, getContentMappings, getDefaultContentMapping, getDefaultContentMapping, getResourceOID, getScopes, getSystemContentMapping, getSystemContentMapping, isEmpty
Method Detail addContentPath
void addContentPath(java.lang.String contentPath, boolean isDefault, java.lang.String scope, boolean isDelegating, Identifiable contentProxyResource) throws AmbigousContentPathException, MissingAccessRightsException, ContentMappingDataBackendException, MalformedContentPathException, AmbigousContentMappingDefaultException
- Adds a mapping to a content object which is identified via its content path. This content mapping will be transformed into an content ID based mappings when committing this object.
- Parameters:
- contentPath - The path to the content resource.
- isDefault - Indicates whether this mapping shall be the default mapping in the given scope
- scope - The scope for this mapping. This parameter may be null indicating the default scope.
- isDelegating - Indicates whether this mapping is activated for access control delegation
- contentProxyResource - The proxy resource guarding all content resources affected by this content mapping. In Lotus Web Content Management, the content proxy resource of a given resource is the web content library containing the resource.
- Throws:
- AmbigousContentPathException - If the specified contentPath is already mapped
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed.
- AmbigousContentMappingDefaultException - If there exists another mapping flagged for being the default mapping in the given scope.
addContentID
void addContentID(java.lang.String contentId, boolean isDefault, java.lang.String scope, boolean isDelegating, Identifiable contentProxyResource) throws AmbigousContentIDException, MissingAccessRightsException, ContentMappingDataBackendException, AmbigousContentMappingDefaultException
- Adds a mapping to a content object which is identified via its content ID.
- Parameters:
- contentId - The content ID
- isDefault - Indicates whether this mapping shall be the default mapping in the given scope
- scope - The scope for this mapping. This parameter may be null indicating the default scope.
- isDelegating - Indicates whether this mapping is activated for access control delegation
- contentProxyResource - The proxy resource guarding all content resources affected by this content mapping. In Lotus Web Content Management, the content proxy resource of a given resource is the web content library containing the resource.
- Throws:
- AmbigousContentPathException - If the specified contentPath is already mapped
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException - If there exists another mapping flagged for being the default mapping in the given scope.
- AmbigousContentIDException
addContentPath
void addContentPath(java.lang.String contentPath, boolean isDefault, java.lang.String scope, boolean isDelegating) throws AmbigousContentPathException, MissingAccessRightsException, ContentMappingDataBackendException, MalformedContentPathException, AmbigousContentMappingDefaultException
- Adds a mapping to a content object which is identified via its content path. This content mapping will be transformed into an content ID based mappings when committing this object.
- Parameters:
- contentPath - The content Path.
- isDefault - Indicates whether this mapping shall be the default mapping in the given scope
- scope - The scope for this mapping. This parameter may be null indicating the default scope.
- isDelegating - Indicates whether this mapping is activated for access control delegation
- Throws:
- AmbigousContentPathException - If the specified contentPath is already mapped
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException - If there exists another mapping flagged for being the default mapping in the given scope.
addContentID
void addContentID(java.lang.String contentId, boolean isDefault, java.lang.String scope, boolean isDelegating) throws AmbigousContentIDException, MissingAccessRightsException, ContentMappingDataBackendException, AmbigousContentMappingDefaultException
- Adds a mapping to a content object which is identified via its content ID.
- Parameters:
- contentId - The content ID
- isDefault - Indicates whether this mapping shall be the default mapping in the given scope
- scope - The scope for this mapping. This parameter may be null indicating the default scope.
- isDelegating - Indicates whether this mapping is activated for access control delegation
- Throws:
- AmbigousContentPathException - If the specified contentPath is already mapped
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException - If there exists another mapping flagged for being the default mapping in the given scope.
- AmbigousContentIDException
addContentPath
void addContentPath(java.lang.String contentPath, boolean isDefault, java.lang.String scope) throws AmbigousContentPathException, MissingAccessRightsException, ContentMappingDataBackendException, MalformedContentPathException, AmbigousContentMappingDefaultException
- Adds a (non-delegating) mapping to a content object which is identified via its content path. This content mapping will be transformed into an content ID based mappings when committing this object.
- Parameters:
- contentPath - The content Path.
- isDefault - Indicates whether this mapping shall be the default mapping in the given scope
- scope - The scope for this mapping. This parameter may be null indicating the default scope.
- Throws:
- AmbigousContentPathException - If the specified contentPath is already mapped
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException - If there exists another mapping flagged for being the default mapping in the given scope.
addContentID
void addContentID(java.lang.String contentId, boolean isDefault, java.lang.String scope) throws AmbigousContentIDException, MissingAccessRightsException, ContentMappingDataBackendException, AmbigousContentMappingDefaultException
- Adds a (non-delegating) mapping to a content object which is identified via its content ID.
- Parameters:
- contentId - The content ID
- isDefault - Indicates whether this mapping shall be the default mapping in the given scope
- scope - The scope for this mapping. This parameter may be null indicating the default scope.
- Throws:
- AmbigousContentPathException - If the specified contentPath is already mapped
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException - If there exists another mapping flagged for being the default mapping in the given scope.
- AmbigousContentIDException
setScopeByContentPath
void setScopeByContentPath(java.lang.String contentPath, java.lang.String scope) throws ContentMappingNotFoundException, MalformedContentPathException
- Sets the scope for an existing mapping identified by its content path.
- Parameters:
- contentPath - The content path identifying the mapping to be updated.
- scope - The new scope value. This parameter may be null indicating the default scope.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
setScopeByContentID
void setScopeByContentID(java.lang.String contentId, java.lang.String scope) throws ContentMappingNotFoundException
- Sets the scope for an existing mapping identified by its content ID.
- Parameters:
- contentId - The content ID identifying the mapping to be updated
- scope - The new scope value. This parameter may be null indicating the default scope.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
setDefaultByContentPath
void setDefaultByContentPath(java.lang.String contentPath, boolean isDefault) throws ContentMappingNotFoundException, MalformedContentPathException, AmbigousContentMappingDefaultException
- Sets the default content flag for an existing mapping identified by its content path.
- Parameters:
- contentPath - The content path identifying the mapping to be updated.
- isDefault - The new flag value
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException
setDefaultByContentID
void setDefaultByContentID(java.lang.String contentId, boolean isDefault) throws ContentMappingNotFoundException, AmbigousContentMappingDefaultException
- Sets the default content flag for an existing mapping identified by its content ID.
- Parameters:
- contentId - The content ID identifying the mapping to be updated
- isDefault - The new flag value
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- AmbigousContentMappingDefaultException
setDelegatingByContentPath
void setDelegatingByContentPath(java.lang.String contentPath, boolean isDelegating, Identifiable contentProxyResource) throws ContentMappingNotFoundException, MissingAccessRightsException, MalformedContentPathException, ContentMappingDataBackendException
- Sets the access control delegation flag for an existing mapping identified by its content path.
- Parameters:
- contentPath - The content path identifying the mapping to be updated.
- isDelegating - The new flag value
- contentProxyResource - The proxy resource guarding all content resources affected by this content mapping. In Lotus Web Content Management, the content proxy resource of a given resource is the web content library containing the resource.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- ContentMappingDataBackendException - If the data backend access fails
- MissingAccessRightsException
setDelegatingByContentID
void setDelegatingByContentID(java.lang.String contentId, boolean isDelegating, Identifiable contentProxyResource) throws ContentMappingNotFoundException, MissingAccessRightsException, ContentMappingDataBackendException
- Sets the access control delegation flag for an existing mapping identified by its content ID.
- Parameters:
- contentId - The content ID identifying the mapping to be updated
- isDelegating - The new flag value
- contentProxyResource - The proxy resource guarding all content resources affected by this content mapping. In Lotus Web Content Management, the content proxy resource of a given resource is the web content library containing the resource.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- MissingAccessRightsException
setDelegatingByContentPath
void setDelegatingByContentPath(java.lang.String contentPath, boolean isDelegating) throws ContentMappingNotFoundException, MissingAccessRightsException, MalformedContentPathException, ContentMappingDataBackendException
- Sets the access control delegation flag for an existing mapping identified by its content path.
- Parameters:
- contentPath - The content path identifying the mapping to be updated.
- isDelegating - The new flag value
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- ContentMappingDataBackendException - If the data backend access fails
- MissingAccessRightsException
setDelegatingByContentID
void setDelegatingByContentID(java.lang.String contentId, boolean isDelegating) throws ContentMappingNotFoundException, MissingAccessRightsException, ContentMappingDataBackendException
- Sets the access control delegation flag for an existing mapping identified by its content ID.
- Parameters:
- contentId - The content ID identifying the mapping to be updated
- isDelegating - The new flag value
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- ContentMappingDataBackendException - If the data backend access fails
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- MissingAccessRightsException
removeContentPath
void removeContentPath(java.lang.String contentPath, Identifiable contentProxyResource) throws ContentMappingNotFoundException, MalformedContentPathException, MissingAccessRightsException, ContentMappingDataBackendException, ContentMappingModificationNotAllowedException
- Removes a content mapping identified by its content path.
- Parameters:
- contentPath - The content path identifying the mapping to be removed.
- contentProxyResource - The proxy resource guarding all content resources affected by this content mapping. In Lotus Web Content Management, the content proxy resource of a given resource is the web content library containing the resource. This parameter is only required if mapping to be removed is enabled for delegation.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- ContentMappingDataBackendException - If the data backend access fails
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingModificationNotAllowedException - If the user tried to modify a content mapping, but was not allowed to (e.g. removing a system content mapping)
removeContentID
void removeContentID(java.lang.String contentId, Identifiable contentProxyResource) throws ContentMappingNotFoundException, MissingAccessRightsException, ContentMappingDataBackendException, ContentMappingModificationNotAllowedException
- Removes a content mapping identified by its content ID.
- Parameters:
- contentId - The content ID identifying the mapping to be removed
- contentProxyResource - The proxy resource guarding all content resources affected by this content mapping. In Lotus Web Content Management, the content proxy resource of a given resource is the web content library containing the resource. This parameter is only required if mapping to be removed is enabled for delegation.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- ContentMappingDataBackendException - If the data backend access fails
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingModificationNotAllowedException - If the user tried to modify a content mapping, but was not allowed to (e.g. removing a system content mapping)
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
removeContentPath
void removeContentPath(java.lang.String contentPath) throws ContentMappingNotFoundException, MalformedContentPathException, MissingAccessRightsException, ContentMappingDataBackendException, ContentMappingModificationNotAllowedException
- Removes a content mapping identified by its content path.
- Parameters:
- contentPath - The content path identifying the mapping to be removed.
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
- ContentMappingDataBackendException - If the data backend access fails
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingModificationNotAllowedException - If the user tried to modify a content mapping, but was not allowed to (e.g. removing a system content mapping)
removeContentID
void removeContentID(java.lang.String contentId) throws ContentMappingNotFoundException, MissingAccessRightsException, ContentMappingDataBackendException, ContentMappingModificationNotAllowedException
- Removes a content mapping identified by its content ID.
- Parameters:
- contentId - The content ID identifying the mapping to be removed
- Throws:
- ContentMappingNotFoundException - If the content could not be found
- ContentMappingDataBackendException - If the data backend access fails
- MissingAccessRightsException - If the user is lacking access privileges to add this content mapping
- ContentMappingModificationNotAllowedException - If the user tried to modify a content mapping, but was not allowed to (e.g. removing a system content mapping)
- MalformedContentPathException - If the content path is malformed. (content paths must start with "/" but must not end with a "/")
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD