oracle.ifs.beans.lifecycle

Interface LifecycleDateRule

All Known Implementing Classes:

DailyLifecycleDateRule, ImmediateLifecycleDateRule, LifecycleDateRuleAdapter, MonthlyLifecycleDateRule

public interface LifecycleDateRule

Interface used to determine the LifecycleDate of Documents whose lifecycle is being managed by a LifecyclePolicy.

Author:

Dave Long

Method Summary

Modifier and Type	Method and Description
Date	getLifecycleDate(Date createDate) Determine the LifecycleDate based on a creation date and the specified LifecyclePolicy.
Date	getLifecycleDate(Document doc) Determine the LifecycleDate for the specified document and the specified LifecyclePolicy.
void	initialize(LifecycleDateRuleSpecification ldrs) Initialize this instance.

Method Detail

initialize

void initialize(LifecycleDateRuleSpecification ldrs)
         throws IfsException

Initialize this instance.

Called immediately after construction (via the default constructor) and used so that the implementation can initialize session-independent state. This instance may be used concurrently by multiple threads.

Parameters:

ldrs - the LifecycleDateRuleSpecification that references this instance

Throws:

IfsException - if the operation fails

getLifecycleDate

Date getLifecycleDate(Document doc)
               throws IfsException

Determine the LifecycleDate for the specified document and the specified LifecyclePolicy.

This variant assumes the document has been created and that the LifecyclePolicy specified during initialization is being assigned to the document.

Parameters:

doc - the Document

Returns:

the LifecycleDate to use for the document

Throws:

IfsException - if the operation fails

getLifecycleDate

Date getLifecycleDate(Date createDate)
               throws IfsException

Determine the LifecycleDate based on a creation date and the specified LifecyclePolicy.

This variant takes a document creation date and a LifecyclePolicy, and is typically used when creating a document and assigning a LifecyclePolicy at the same time.

Parameters:

createDate - the creation date of a Document being created

Returns:

the LifecycleDate to use for the document

Throws:

IfsException - if the operation fails