summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/request/IPolicy.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/request/IPolicy.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/request/IPolicy.java41
1 files changed, 23 insertions, 18 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/request/IPolicy.java b/pki/base/common/src/com/netscape/certsrv/request/IPolicy.java
index 06262fee3..d74a32a43 100644
--- a/pki/base/common/src/com/netscape/certsrv/request/IPolicy.java
+++ b/pki/base/common/src/com/netscape/certsrv/request/IPolicy.java
@@ -17,32 +17,37 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.request;
+
/**
- * Interface to a policy. The policy evaluates the request for correctness and
- * completeness. It may change or add to values stored in the request. The
- * policy object also decides whether a request should be queue to await
- * approval by an agent. FUTURE: In this case, the policy should set the
- * 'agentGroup' entry in the request to indicate the group of agents allowed to
- * perform further processing. If none is set, a default value
- * ("defaultAgentGroup") will be set instead.
- *
+ * Interface to a policy. The policy evaluates the request for
+ * correctness and completeness. It may change or add to values
+ * stored in the request. The policy object also decides
+ * whether a request should be queue to await approval by
+ * an agent.
+ * FUTURE: In this case, the policy should set the
+ * 'agentGroup' entry in the request to indicate the group
+ * of agents allowed to perform further processing. If none
+ * is set, a default value ("defaultAgentGroup") will be
+ * set instead.
+ *
* @version $Revision$, $Date$
*/
public interface IPolicy {
/**
- * Applies the policy check to the request. The policy should determine
- * whether the request can be processed immediately, or should be held
- * pending manual approval.
+ * Applies the policy check to the request. The policy should
+ * determine whether the request can be processed immediately,
+ * or should be held pending manual approval.
* <p>
- * The policy can update fields in the request, to add additional values or
- * to restrict the values to pre-determined ranges.
+ * The policy can update fields in the request, to add additional values
+ * or to restrict the values to pre-determined ranges.
* <p>
- *
- * @param request the request to check
- * @return a result code indicating the result of the evaluation. The
- * processor will determine the next request processing step based
- * on this value
+ * @param request
+ * the request to check
+ * @return
+ * a result code indicating the result of the evaluation. The
+ * processor will determine the next request processing step based
+ * on this value
*/
PolicyResult apply(IRequest request);
}