AquaLogic Interaction Development Kit (IDK) 6.0.0

IContentItemManager.ExpireContentItem Method 

Expires a IContentItem so it can no longer be published.

void ExpireContentItem(
   IContentItem contentItem
);

Parameters

contentItem
The content item to expire; cannot be null.

Remarks

This method removes the published content for a content item from the publish target of Publisher. After an item is expired, UnexpireContentItem can be used to re-publish the item. Content items cannot be expired multiple times consecutively.

// Publish a persisted content item with
// an attached Data Entry Template and
// a Presentation Template associated
contentItemManager.PublishContentItem(contentItem);
// Expire the published content (e.g. the published html file)
// and mark the content item as expired
contentItemManager.ExpireContentItem(contentItem);
// Unexpire the published content and content item
contentItemManager.UnexpireContentItem(contentItem);
// The content item can again be published

Exceptions

Exception Type Condition
ContentSecurityException The user does not have permission to expire the item.
InvalidOperationException The the content item has not been persisted or has already been removed.
ContentException The method call resulted in a Publisher exception. For example, expiring a content item multiple times or expiring a content item that has not been published will cause this exception.
SoapException There was a communication problem during the execution of the remote method call.

See Also

IContentItemManager Interface | Plumtree.Remote.PRC.Content.Item Namespace