org.kuali.rice.kew.dto
Class RouteHeaderDTO

java.lang.Object
  org.kuali.rice.kew.dto.RouteHeaderDTO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DocumentDetailDTO

public class RouteHeaderDTO
extends Object
implements Serializable

Transport object for the DocumentRouteHeaderValue. Represents a document to the client programmer

Author:

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

See Also:

Serialized Form

Field Summary

private boolean	ackRequested
private String	appDocId
private String	appDocStatus
private Calendar	appDocStatusDate
private boolean	approveRequested
private boolean	completeRequested
private String	currentRouteNodeNames
private Calendar	dateApproved
private Calendar	dateCreated
private Calendar	dateFinalized
private Calendar	dateLastModified
private Integer	docRouteLevel
private String	docRouteStatus
private String	docTitle
private Long	docTypeId
private String	docTypeName
private String	documentId
private String	documentUrl
private Integer	docVersion
private boolean	fyiRequested
private String	initiatorPrincipalId
private NoteDTO[]	notes
private NoteDTO[]	notesToDelete
private String	routedByPrincipalId
(package private) static long	serialVersionUID
private boolean	userBlanketApprover
private ValidActionsDTO	validActions
private List<KeyValue>	variables Probably needs to be an array for web services

Constructor Summary

RouteHeaderDTO()

Method Summary

private KeyValue	findVariable(String name)
String	getAppDocId()
String	getAppDocStatus()
Calendar	getAppDocStatusDate()
String	getCurrentRouteNodeNames()
Calendar	getDateApproved()
Calendar	getDateCreated()
Calendar	getDateFinalized()
Calendar	getDateLastModified()
Integer	getDocRouteLevel()
String	getDocRouteStatus()
String	getDocTitle()
Long	getDocTypeId()
String	getDocTypeName() Deprecated. this is unreliable user docTypeId to retrieve document type
String	getDocumentId()
String	getDocumentUrl()
Integer	getDocVersion()
String	getInitiatorPrincipalId()
NoteDTO[]	getNotes()
NoteDTO[]	getNotesToDelete()
String	getRoutedByPrincipalId()
ValidActionsDTO	getValidActions()
String	getVariable(String name)
List<KeyValue>	getVariables()
boolean	isAckRequested()
boolean	isApproveRequested()
boolean	isCompleteRequested()
private boolean	isEqual(String a, String b)
boolean	isFyiRequested()
boolean	isUserBlanketApprover()
void	setAckRequested(boolean ackRequested)
void	setAppDocId(String appDocId)
void	setAppDocStatus(String appDocStatus)
void	setAppDocStatusDate(Calendar date)
void	setApproveRequested(boolean approveRequested)
void	setCompleteRequested(boolean completeRequested)
void	setCurrentRouteNodeNames(String currentRouteNodeNames)
void	setDateApproved(Calendar dateApproved)
void	setDateCreated(Calendar dateCreated)
void	setDateFinalized(Calendar dateFinalized)
void	setDateLastModified(Calendar dateLastModified)
void	setDocRouteLevel(Integer docRouteLevel)
void	setDocRouteStatus(String docRouteStatus)
void	setDocTitle(String docTitle)
void	setDocTypeId(Long docTypeId)
void	setDocTypeName(String docTypeName) Deprecated. this is unreliable user docTypeId to retrieve document type
void	setDocumentId(String documentId)
void	setDocumentUrl(String documentUrl)
void	setDocVersion(Integer docVersion)
void	setFyiRequested(boolean fyiRequested)
void	setInitiatorPrincipalId(String initiatorPrincipalId)
void	setNotes(NoteDTO[] notes)
void	setNotesToDelete(NoteDTO[] notesToDelete)
void	setRoutedByPrincipalId(String routedByPrincipalId)
void	setUserBlanketApprover(boolean userBlanketApprover)
void	setValidActions(ValidActionsDTO validActions)
void	setVariable(String name, String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

documentId

private String documentId

docRouteStatus

private String docRouteStatus

dateCreated

private Calendar dateCreated

dateLastModified

private Calendar dateLastModified

dateApproved

private Calendar dateApproved

dateFinalized

private Calendar dateFinalized

docTitle

private String docTitle

appDocId

private String appDocId

initiatorPrincipalId

private String initiatorPrincipalId

routedByPrincipalId

private String routedByPrincipalId

docRouteLevel

private Integer docRouteLevel

currentRouteNodeNames

private String currentRouteNodeNames

docVersion

private Integer docVersion

docTypeName

private String docTypeName

documentUrl

private String documentUrl

appDocStatus

private String appDocStatus

appDocStatusDate

private Calendar appDocStatusDate

fyiRequested

private boolean fyiRequested

ackRequested

private boolean ackRequested

approveRequested

private boolean approveRequested

completeRequested

private boolean completeRequested

userBlanketApprover

private boolean userBlanketApprover

docTypeId

private Long docTypeId

validActions

private ValidActionsDTO validActions

notes

private NoteDTO[] notes

notesToDelete

private NoteDTO[] notesToDelete

variables

private List<KeyValue> variables

Probably needs to be an array for web services

Constructor Detail

RouteHeaderDTO

public RouteHeaderDTO()

Method Detail

getCurrentRouteNodeNames

public String getCurrentRouteNodeNames()

setCurrentRouteNodeNames

public void setCurrentRouteNodeNames(String currentRouteNodeNames)

getAppDocId

public String getAppDocId()

setAppDocId

public void setAppDocId(String appDocId)

getDateApproved

public Calendar getDateApproved()

setDateApproved

public void setDateApproved(Calendar dateApproved)

getDateCreated

public Calendar getDateCreated()

setDateCreated

public void setDateCreated(Calendar dateCreated)

getDateFinalized

public Calendar getDateFinalized()

setDateFinalized

public void setDateFinalized(Calendar dateFinalized)

getDateLastModified

public Calendar getDateLastModified()

setDateLastModified

public void setDateLastModified(Calendar dateLastModified)

getDocRouteLevel

public Integer getDocRouteLevel()

setDocRouteLevel

public void setDocRouteLevel(Integer docRouteLevel)

getDocRouteStatus

public String getDocRouteStatus()

setDocRouteStatus

public void setDocRouteStatus(String docRouteStatus)

getAppDocStatus

public String getAppDocStatus()

setAppDocStatus

public void setAppDocStatus(String appDocStatus)

getAppDocStatusDate

public Calendar getAppDocStatusDate()

setAppDocStatusDate

public void setAppDocStatusDate(Calendar date)

getDocTitle

public String getDocTitle()

setDocTitle

public void setDocTitle(String docTitle)

getDocTypeName

public String getDocTypeName()

Deprecated. this is unreliable user docTypeId to retrieve document type

setDocTypeName

public void setDocTypeName(String docTypeName)

Deprecated. this is unreliable user docTypeId to retrieve document type

getDocumentUrl

public String getDocumentUrl()

setDocumentUrl

public void setDocumentUrl(String documentUrl)

getDocVersion

public Integer getDocVersion()

setDocVersion

public void setDocVersion(Integer docVersion)

getInitiatorPrincipalId

public String getInitiatorPrincipalId()

setInitiatorPrincipalId

public void setInitiatorPrincipalId(String initiatorPrincipalId)

getRoutedByPrincipalId

public String getRoutedByPrincipalId()

setRoutedByPrincipalId

public void setRoutedByPrincipalId(String routedByPrincipalId)

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

isAckRequested

public boolean isAckRequested()

setAckRequested

public void setAckRequested(boolean ackRequested)

isApproveRequested

public boolean isApproveRequested()

setApproveRequested

public void setApproveRequested(boolean approveRequested)

isCompleteRequested

public boolean isCompleteRequested()

setCompleteRequested

public void setCompleteRequested(boolean completeRequested)

isFyiRequested

public boolean isFyiRequested()

setFyiRequested

public void setFyiRequested(boolean fyiRequested)

isUserBlanketApprover

public boolean isUserBlanketApprover()

setUserBlanketApprover

public void setUserBlanketApprover(boolean userBlanketApprover)

getDocTypeId

public Long getDocTypeId()

setDocTypeId

public void setDocTypeId(Long docTypeId)

getNotes

public NoteDTO[] getNotes()

setNotes

public void setNotes(NoteDTO[] notes)

getNotesToDelete

public NoteDTO[] getNotesToDelete()

setNotesToDelete

public void setNotesToDelete(NoteDTO[] notesToDelete)

findVariable

private KeyValue findVariable(String name)

getVariable

public String getVariable(String name)

setVariable

public void setVariable(String name,
                        String value)

getVariables

public List<KeyValue> getVariables()

getValidActions

public ValidActionsDTO getValidActions()

setValidActions

public void setValidActions(ValidActionsDTO validActions)

isEqual

private boolean isEqual(String a,
                        String b)