org.kuali.rice.kew.util
Class FutureRequestDocumentStateManager

java.lang.Object
  extended by org.kuali.rice.kew.util.FutureRequestDocumentStateManager

public class FutureRequestDocumentStateManager
extends Object

Manages document state in relation to users seeing future requests for a particular document. Construct the object with a document and a user and ask it questions in relation to future requests.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Field Summary
static String DEACTIVATED_REQUESTS_VARY_KEY
           
static String FUTURE_REQUESTS_VAR_KEY
           
 
Constructor Summary
FutureRequestDocumentStateManager(DocumentRouteHeaderValue document, Group kimGroup)
           
FutureRequestDocumentStateManager(DocumentRouteHeaderValue document, String principalId)
           
 
Method Summary
protected  void clearStateFromDocument(DocumentRouteHeaderValue document)
           
protected  boolean isClearFutureRequests(BranchState state)
           
 boolean isClearFutureRequestState()
           
 boolean isDoNotReceiveFutureRequests()
           
protected  boolean isDoNotReceiveFutureRequests(BranchState state)
           
 boolean isReceiveFutureRequests()
           
protected  boolean isReceiveFutureRequests(BranchState state)
           
protected  boolean isStateForUser(BranchState state, String principalId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FUTURE_REQUESTS_VAR_KEY

public static final String FUTURE_REQUESTS_VAR_KEY
See Also:
Constant Field Values

DEACTIVATED_REQUESTS_VARY_KEY

public static final String DEACTIVATED_REQUESTS_VARY_KEY
See Also:
Constant Field Values
Constructor Detail

FutureRequestDocumentStateManager

public FutureRequestDocumentStateManager(DocumentRouteHeaderValue document,
                                         String principalId)

FutureRequestDocumentStateManager

public FutureRequestDocumentStateManager(DocumentRouteHeaderValue document,
                                         Group kimGroup)
Method Detail

clearStateFromDocument

protected void clearStateFromDocument(DocumentRouteHeaderValue document)

isStateForUser

protected boolean isStateForUser(BranchState state,
                                 String principalId)

isReceiveFutureRequests

protected boolean isReceiveFutureRequests(BranchState state)

isDoNotReceiveFutureRequests

protected boolean isDoNotReceiveFutureRequests(BranchState state)

isClearFutureRequests

protected boolean isClearFutureRequests(BranchState state)

isClearFutureRequestState

public boolean isClearFutureRequestState()

isDoNotReceiveFutureRequests

public boolean isDoNotReceiveFutureRequests()

isReceiveFutureRequests

public boolean isReceiveFutureRequests()


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.