Java Doc for DocumentRouteHeaderValue.java in » ERP-CRM-Financial » Kuali-Financial-System » edu » iu » uis » eden » routeheader » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » ERP CRM Financial » Kuali Financial System » edu.iu.uis.eden.routeheader

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

edu.iu.uis.eden.routeheader .DocumentRouteHeaderValue

All known Subclasses:   edu.iu.uis.eden.routeheader .DocumentRouteHeaderValueActionListExtension,
DocumentRouteHeaderValue
public class DocumentRouteHeaderValue implements WorkflowPersistable(Code)
A document within KEW. A document effectively represents a process that moves through the workflow engine. It is created from a particular DocumentType and follows the route path defined by that DocumentType.
During a document's lifecycle it progresses through a series of statuses, starting with INITIATED and moving to one of the terminal states (such as FINAL, CANCELED, etc). The list of status on a document are defined in the EdenConstants class and include the constants starting with "ROUTE_HEADER_" and ending with "_CD".
Associated with the document is the document content. The document content is XML which represents the content of that document. This XML content is typically used to make routing decisions for the document.
A document has associated with it a set of ActionRequestValue object and ActionTakenValue objects. Action Requests represent requests for user action (such as Approve, Acknowledge, etc). Action Takens represent action that users have performed on the document, such as approvals or cancelling of the document.
The instantiated route path of a document is defined by it's graph of RouteNodeInstance objects. The path starts at the initial node of the document and progresses from there following the next nodes of each node instance. The current active nodes on the document are defined by the "active" flag on the node instance where are not marked as "complete".
See Also:   DocumentType
See Also:   ActionRequestValue
See Also:   ActionItem
See Also:   ActionTakenValue
See Also:   RouteNodeInstance
See Also:   EdenConstants
author:
   rkirkend
author:
   bmcough
author:
   ewestfal

Field Summary
final public static String CURRENT_ROUTE_NODE_NAME_DELIMITER

final protected static HashMap<String, String> legalActions

final protected static HashMap<String, String> stateTransitionMap


Constructor Summary
public DocumentRouteHeaderValue()


Method Summary
public Object copy(boolean preserveKeys)

public List<ActionItem> getActionItems()

public List<ActionRequestValue> getActionRequests()

public List<ActionTakenValue> getActionsTaken()

public java.lang.String getAppDocId()

public java.sql.Timestamp getApprovedDate()

public java.sql.Timestamp getCreateDate()

public String getCurrentRouteLevelName()

public CustomActionListAttribute getCustomActionListAttribute()

public CustomEmailAttribute getCustomEmailAttribute()

public CustomNoteAttribute getCustomNoteAttribute()

public ActionItem getDocActionItem(int index)

public ActionRequestValue getDocActionRequest(int index)

public ActionTakenValue getDocActionTaken(int index)

public java.lang.String getDocContent()

public java.lang.Integer getDocRouteLevel()

public java.lang.String getDocRouteStatus()

public String getDocRouteStatusLabel()

public java.lang.String getDocTitle()

public java.lang.Integer getDocVersion()

public DocumentRouteHeaderValueContent getDocumentContent()

public DocumentType getDocumentType()

public java.lang.Long getDocumentTypeId()

public java.sql.Timestamp getFinalizedDate()

public RouteNodeInstance getInitialRouteNodeInstance(int index)

public List<RouteNodeInstance> getInitialRouteNodeInstances()

public WorkflowUser getInitiatorUser()

public java.lang.String getInitiatorWorkflowId()

public java.lang.Integer getJrfVerNbr()

public String getLockCode()

public List<Note> getNotes()

public java.lang.String getOverrideInd()

public Collection getQueueItems()

public java.lang.Long getRouteHeaderId()

public java.sql.Timestamp getRouteLevelDate()

public java.sql.Timestamp getRouteStatusDate()

public String getRouteStatusLabel()

public WorkflowUser getRoutedByUser()

public java.lang.String getRoutedByUserWorkflowId()

public List<SearchableAttributeValue> getSearchableAttributeValues()

public java.sql.Timestamp getStatusModDate()

public String getVariable(String name)

public boolean isApproved()

public boolean isCanceled()

public boolean isDisaproved()

public boolean isEnroute()

public boolean isFinal()

public boolean isInException()

public boolean isLocked()

public boolean isProcessed()

public boolean isRoutable()

public boolean isRouted()

public boolean isRoutingReport()

public boolean isStateInitiated()

public boolean isStateSaved()

public boolean isValidActionToTake(String actionCd)
     Return true if the given action code is valid for this document's current state.
Parameters:
  actionCd - The action code to be tested.
public boolean isValidStatusChange(String newStatus)

public void markDocumentApproved()
     Mark the document as being approved.
public void markDocumentCanceled()
     Mark document cancled.
public void markDocumentDisapproved()

public void markDocumentEnroute()
     Mark the document as being actively routed.
public void markDocumentFinalized()
     Mark document finalized.
public void markDocumentInException()
     Mark the document as being in the exception state.
public void markDocumentProcessed()
     Mark the document as being processed.
public void markDocumentSaved()

public void setActionItems(List<ActionItem> actionItems)

public void setActionRequests(List<ActionRequestValue> actionRequests)

public void setActionsTaken(List<ActionTakenValue> actionsTaken)

public void setAppDocId(java.lang.String appDocId)

public void setApprovedDate(java.sql.Timestamp approvedDate)

public void setCreateDate(java.sql.Timestamp createDate)

public void setDocContent(java.lang.String docContent)

public void setDocRouteLevel(java.lang.Integer docRouteLevel)

public void setDocRouteStatus(java.lang.String docRouteStatus)

public void setDocTitle(java.lang.String docTitle)

public void setDocVersion(java.lang.Integer docVersion)

public void setDocumentContent(DocumentRouteHeaderValueContent documentContent)

public void setDocumentTypeId(java.lang.Long docTypeId)

public void setFinalizedDate(java.sql.Timestamp finalizedDate)

public void setInitialRouteNodeInstances(List<RouteNodeInstance> initialRouteNodeInstances)

public void setInitiatorWorkflowId(java.lang.String initiatorWorkflowId)

public void setJrfVerNbr(java.lang.Integer jrfVerNbr)

public void setLockCode(String lockReason)

public void setNotes(List<Note> notes)

public void setOverrideInd(java.lang.String overrideInd)

public void setQueueItems(Collection queueItems)

public void setRouteHeaderData(RouteHeaderVO routeHeaderVO)

public void setRouteHeaderId(java.lang.Long routeHeaderId)

public void setRouteLevelDate(java.sql.Timestamp routeLevelDate)

public void setRouteStatus(String newStatus, boolean finalState)

public void setRouteStatusDate(java.sql.Timestamp routeStatusDate)

public void setRoutedByUserWorkflowId(java.lang.String routedByUserWorkflowId)

public void setRoutingReport(boolean routingReport)

public void setSearchableAttributeValues(List<SearchableAttributeValue> searchableAttributeValues)

public void setStatusModDate(java.sql.Timestamp statusModDate)

public void setVariable(String name, String value)

public void unlock()


Field Detail
CURRENT_ROUTE_NODE_NAME_DELIMITER
final public static String CURRENT_ROUTE_NODE_NAME_DELIMITER(Code)

legalActions
final protected static HashMap<String, String> legalActions(Code)

stateTransitionMap
final protected static HashMap<String, String> stateTransitionMap(Code)

Constructor Detail
DocumentRouteHeaderValue
public DocumentRouteHeaderValue()(Code)

Method Detail
copy
public Object copy(boolean preserveKeys)(Code)

getActionItems
public List<ActionItem> getActionItems()(Code)

getActionRequests
public List<ActionRequestValue> getActionRequests()(Code)

getActionsTaken
public List<ActionTakenValue> getActionsTaken()(Code)

getAppDocId
public java.lang.String getAppDocId()(Code)

getApprovedDate
public java.sql.Timestamp getApprovedDate()(Code)

getCreateDate
public java.sql.Timestamp getCreateDate()(Code)

getCurrentRouteLevelName
public String getCurrentRouteLevelName()(Code)

getCustomActionListAttribute
public CustomActionListAttribute getCustomActionListAttribute() throws WorkflowException, EdenUserNotFoundException(Code)

getCustomEmailAttribute
public CustomEmailAttribute getCustomEmailAttribute() throws WorkflowException, EdenUserNotFoundException(Code)

getCustomNoteAttribute
public CustomNoteAttribute getCustomNoteAttribute() throws WorkflowException, EdenUserNotFoundException(Code)

getDocActionItem
public ActionItem getDocActionItem(int index)(Code)

getDocActionRequest
public ActionRequestValue getDocActionRequest(int index)(Code)

getDocActionTaken
public ActionTakenValue getDocActionTaken(int index)(Code)

getDocContent
public java.lang.String getDocContent()(Code)

getDocRouteLevel
public java.lang.Integer getDocRouteLevel()(Code)

getDocRouteStatus
public java.lang.String getDocRouteStatus()(Code)

getDocRouteStatusLabel
public String getDocRouteStatusLabel()(Code)

getDocTitle
public java.lang.String getDocTitle()(Code)

getDocVersion
public java.lang.Integer getDocVersion()(Code)

getDocumentContent
public DocumentRouteHeaderValueContent getDocumentContent()(Code)

getDocumentType
public DocumentType getDocumentType()(Code)

getDocumentTypeId
public java.lang.Long getDocumentTypeId()(Code)

getFinalizedDate
public java.sql.Timestamp getFinalizedDate()(Code)

getInitialRouteNodeInstance
public RouteNodeInstance getInitialRouteNodeInstance(int index)(Code)

getInitialRouteNodeInstances
public List<RouteNodeInstance> getInitialRouteNodeInstances()(Code)

getInitiatorUser
public WorkflowUser getInitiatorUser() throws EdenUserNotFoundException(Code)

getInitiatorWorkflowId
public java.lang.String getInitiatorWorkflowId()(Code)

getJrfVerNbr
public java.lang.Integer getJrfVerNbr()(Code)

getLockCode
public String getLockCode()(Code)

getNotes
public List<Note> getNotes()(Code)

getOverrideInd
public java.lang.String getOverrideInd()(Code)

getQueueItems
public Collection getQueueItems()(Code)

getRouteHeaderId
public java.lang.Long getRouteHeaderId()(Code)

getRouteLevelDate
public java.sql.Timestamp getRouteLevelDate()(Code)

getRouteStatusDate
public java.sql.Timestamp getRouteStatusDate()(Code)

getRouteStatusLabel
public String getRouteStatusLabel()(Code)

getRoutedByUser
public WorkflowUser getRoutedByUser() throws EdenUserNotFoundException(Code)

getRoutedByUserWorkflowId
public java.lang.String getRoutedByUserWorkflowId()(Code)

getSearchableAttributeValues
public List<SearchableAttributeValue> getSearchableAttributeValues()(Code)
Returns the searchableAttributeValues.

getStatusModDate
public java.sql.Timestamp getStatusModDate()(Code)

getVariable
public String getVariable(String name)(Code)
Gets a variable
Parameters:
  name - variable name variable value, or null if variable is not defined

isApproved
public boolean isApproved()(Code)
true if the document is in the approved state

isCanceled
public boolean isCanceled()(Code)

isDisaproved
public boolean isDisaproved()(Code)

isEnroute
public boolean isEnroute()(Code)

isFinal
public boolean isFinal()(Code)

isInException
public boolean isInException()(Code)

isLocked
public boolean isLocked()(Code)

isProcessed
public boolean isProcessed()(Code)
true if the document is in the processed state

isRoutable
public boolean isRoutable()(Code)

isRouted
public boolean isRouted()(Code)
true if the document has ever been inte enroute state

isRoutingReport
public boolean isRoutingReport()(Code)

isStateInitiated
public boolean isStateInitiated()(Code)
True if the document is in the state of Initiated

isStateSaved
public boolean isStateSaved()(Code)
True if the document is in the state of Saved

isValidActionToTake
public boolean isValidActionToTake(String actionCd)(Code)
Return true if the given action code is valid for this document's current state.
Parameters:
  actionCd - The action code to be tested. True if the action code is valid for the document's status.

isValidStatusChange
public boolean isValidStatusChange(String newStatus)(Code)

markDocumentApproved
public void markDocumentApproved() throws InvalidActionTakenException(Code)
Mark the document as being approved.
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentCanceled
public void markDocumentCanceled() throws InvalidActionTakenException(Code)
Mark document cancled.
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentDisapproved
public void markDocumentDisapproved() throws InvalidActionTakenException(Code)
Mark document disapproved
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentEnroute
public void markDocumentEnroute() throws InvalidActionTakenException(Code)
Mark the document as being actively routed.
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentFinalized
public void markDocumentFinalized() throws InvalidActionTakenException(Code)
Mark document finalized.
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentInException
public void markDocumentInException() throws InvalidActionTakenException(Code)
Mark the document as being in the exception state.
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentProcessed
public void markDocumentProcessed() throws InvalidActionTakenException(Code)
Mark the document as being processed.
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

markDocumentSaved
public void markDocumentSaved() throws InvalidActionTakenException(Code)
Mark document saved
throws:
  ResourceUnavailableException -
throws:
  InvalidActionTakenException -

setActionItems
public void setActionItems(List<ActionItem> actionItems)(Code)

setActionRequests
public void setActionRequests(List<ActionRequestValue> actionRequests)(Code)

setActionsTaken
public void setActionsTaken(List<ActionTakenValue> actionsTaken)(Code)

setAppDocId
public void setAppDocId(java.lang.String appDocId)(Code)

setApprovedDate
public void setApprovedDate(java.sql.Timestamp approvedDate)(Code)

setCreateDate
public void setCreateDate(java.sql.Timestamp createDate)(Code)

setDocContent
public void setDocContent(java.lang.String docContent)(Code)

setDocRouteLevel
public void setDocRouteLevel(java.lang.Integer docRouteLevel)(Code)

setDocRouteStatus
public void setDocRouteStatus(java.lang.String docRouteStatus)(Code)

setDocTitle
public void setDocTitle(java.lang.String docTitle)(Code)

setDocVersion
public void setDocVersion(java.lang.Integer docVersion)(Code)

setDocumentContent
public void setDocumentContent(DocumentRouteHeaderValueContent documentContent)(Code)

setDocumentTypeId
public void setDocumentTypeId(java.lang.Long docTypeId)(Code)

setFinalizedDate
public void setFinalizedDate(java.sql.Timestamp finalizedDate)(Code)

setInitialRouteNodeInstances
public void setInitialRouteNodeInstances(List<RouteNodeInstance> initialRouteNodeInstances)(Code)

setInitiatorWorkflowId
public void setInitiatorWorkflowId(java.lang.String initiatorWorkflowId)(Code)

setJrfVerNbr
public void setJrfVerNbr(java.lang.Integer jrfVerNbr)(Code)

setLockCode
public void setLockCode(String lockReason)(Code)

setNotes
public void setNotes(List<Note> notes)(Code)

setOverrideInd
public void setOverrideInd(java.lang.String overrideInd)(Code)

setQueueItems
public void setQueueItems(Collection queueItems)(Code)

setRouteHeaderData
public void setRouteHeaderData(RouteHeaderVO routeHeaderVO) throws WorkflowException(Code)
This method takes data from a VO and sets it on this route header
Parameters:
  routeHeaderVO -
throws:
  WorkflowException -

setRouteHeaderId
public void setRouteHeaderId(java.lang.Long routeHeaderId)(Code)

setRouteLevelDate
public void setRouteLevelDate(java.sql.Timestamp routeLevelDate)(Code)

setRouteStatus
public void setRouteStatus(String newStatus, boolean finalState) throws InvalidActionTakenException(Code)

setRouteStatusDate
public void setRouteStatusDate(java.sql.Timestamp routeStatusDate)(Code)

setRoutedByUserWorkflowId
public void setRoutedByUserWorkflowId(java.lang.String routedByUserWorkflowId)(Code)

setRoutingReport
public void setRoutingReport(boolean routingReport)(Code)

setSearchableAttributeValues
public void setSearchableAttributeValues(List<SearchableAttributeValue> searchableAttributeValues)(Code)

Parameters:
  searchableAttributeValues - The searchableAttributeValues to set.

setStatusModDate
public void setStatusModDate(java.sql.Timestamp statusModDate)(Code)

setVariable
public void setVariable(String name, String value)(Code)
Sets a variable
Parameters:
  name - variable name
Parameters:
  value - variable value, or null if variable should be removed

unlock
public void unlock()(Code)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.