org.kuali.rice.kew.actionitem

Class ActionItemBase

java.lang.Object

org.kuali.rice.kew.actionitem.ActionItemBase

All Implemented Interfaces:

Serializable, ActionItemContract

Direct Known Subclasses:

ActionItem, OutboxItem

@MappedSuperclass
public class ActionItemBase
extends Object
implements ActionItemContract, Serializable

This is the model for action items. These are displayed as the action list as well. Mapped to ActionItemService. NOTE: This object contains denormalized fields that have been copied from related ActionRequestValue and DocumentRouteHeaderValue objects for performance reasons. These should be preserved and their related objects should not be added to the OJB mapping as we do not want them loaded for each ActionItem object.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionItemBase()

Method Summary

Modifier and Type	Method and Description
protected <T extends ActionItemBase> T	deepCopy(Map<Object,Object> visited, Class<T> type)
Integer	getActionItemIndex() Deprecated.
Integer	getActionListIndex()
String	getActionRequestCd()
String	getActionRequestId()
String	getActionRequestLabel()
String	getActionToTake() Deprecated.
Map<String,String>	getCustomActions()
Timestamp	getDateAssigned()
String	getDateAssignedString() Deprecated.
String	getDateAssignedStringValue()
org.joda.time.DateTime	getDateTimeAssigned()
DelegationType	getDelegationType()
String	getDelegatorGroupId()
String	getDelegatorName()
String	getDelegatorPrincipalId()
DisplayParameters	getDisplayParameters()
String	getDocHandlerURL()
String	getDocLabel()
String	getDocName()
String	getDocTitle()
String	getDocumentId()
Group	getGroup()
String	getGroupId()
String	getGroupName()
String	getId()
Timestamp	getLastApprovedDate()
DocumentRouteHeaderValue	getMinimalRouteHeader()
Principal	getPrincipal()
String	getPrincipalId()
String	getRecipientTypeCode()
String	getRequestLabel()
String	getResponsibilityId()
String	getRoleName()
DocumentRouteHeaderValue	getRouteHeader()
Timestamp	getRouteHeaderApprovedDate()
String	getRouteHeaderCombinedStatus()
Timestamp	getRouteHeaderCreateDate()
String	getRouteHeaderCurrentRouteLevelName()
String	getRouteHeaderInitiatorName()
String	getRouteHeaderInitiatorWorkflowId()
String	getRouteHeaderRouteStatus()
String	getRowStyleClass()
String	getTarget() Called from ActionList.jsp to help determine the 'target' value when building the URL.
void	initialize(Preferences preferences)
boolean	isWorkgroupItem()
void	setActionListIndex(Integer actionListIndex)
void	setActionRequestCd(String actionRequestCd)
void	setActionRequestId(String actionRequestId)
void	setCustomActions(Map<String,String> customActions)
void	setDateAssigned(Timestamp dateAssigned)
void	setDateAssignedStringValue(String dateAssignedStringValue)
void	setDelegationType(DelegationType delegationType)
void	setDelegatorGroupId(String delegatorGroupId)
void	setDelegatorPrincipalId(String delegatorPrincipalId)
void	setDisplayParameters(DisplayParameters displayParameters)
void	setDocHandlerURL(String docHandlerURL)
void	setDocLabel(String docLabel)
void	setDocName(String docName)
void	setDocTitle(String docTitle)
void	setDocumentId(String documentId)
void	setGroupId(String groupId)
void	setId(String id)
void	setPrincipalId(String principalId)
void	setRequestLabel(String requestLabel)
void	setResponsibilityId(String responsibilityId)
void	setRoleName(String roleName)
void	setRouteHeader(DocumentRouteHeaderValue routeHeader)
void	setRowStyleClass(String rowStyleClass)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionItemBase

public ActionItemBase()

Method Detail

getActionToTake

@Deprecated
public String getActionToTake()

Deprecated.

Description copied from interface: ActionItemContract

This method should never be called, has been deprecated, and will always return null. It was mistakenly added to this interface when it was created and has been left here for compatibility purposes.

Specified by:

getActionToTake in interface ActionItemContract

Returns:

always returns null

getDateAssignedString

@Deprecated
public String getDateAssignedString()

Deprecated.

Description copied from interface: ActionItemContract

This method should never be called, has been deprecated, and will always return null. It was mistakenly added to this interface when it was created and has been left here for compatibility purposes.

Specified by:

getDateAssignedString in interface ActionItemContract

Returns:

always returns null

getDateAssignedStringValue

public String getDateAssignedStringValue()

setDateAssignedStringValue

public void setDateAssignedStringValue(String dateAssignedStringValue)

getId

public String getId()

Specified by:

getId in interface ActionItemContract

getPrincipalId

public String getPrincipalId()

Specified by:

getPrincipalId in interface ActionItemContract

getDateAssigned

public Timestamp getDateAssigned()

getDateTimeAssigned

public org.joda.time.DateTime getDateTimeAssigned()

Specified by:

getDateTimeAssigned in interface ActionItemContract

getActionRequestCd

public String getActionRequestCd()

Specified by:

getActionRequestCd in interface ActionItemContract

getActionRequestId

public String getActionRequestId()

Specified by:

getActionRequestId in interface ActionItemContract

getDocumentId

public String getDocumentId()

Specified by:

getDocumentId in interface ActionItemContract

getGroupId

public String getGroupId()

Specified by:

getGroupId in interface ActionItemContract

getDocTitle

public String getDocTitle()

Specified by:

getDocTitle in interface ActionItemContract

getDocLabel

public String getDocLabel()

Specified by:

getDocLabel in interface ActionItemContract

getDocHandlerURL

public String getDocHandlerURL()

Specified by:

getDocHandlerURL in interface ActionItemContract

getDocName

public String getDocName()

Specified by:

getDocName in interface ActionItemContract

getResponsibilityId

public String getResponsibilityId()

Specified by:

getResponsibilityId in interface ActionItemContract

getRoleName

public String getRoleName()

Specified by:

getRoleName in interface ActionItemContract

getDelegatorPrincipalId

public String getDelegatorPrincipalId()

Specified by:

getDelegatorPrincipalId in interface ActionItemContract

getDelegatorGroupId

public String getDelegatorGroupId()

Specified by:

getDelegatorGroupId in interface ActionItemContract

getDelegationType

public DelegationType getDelegationType()

Specified by:

getDelegationType in interface ActionItemContract

getRequestLabel

public String getRequestLabel()

getGroup

public Group getGroup()

getRecipientTypeCode

public String getRecipientTypeCode()

getActionRequestLabel

public String getActionRequestLabel()

isWorkgroupItem

public boolean isWorkgroupItem()

getPrincipal

public Principal getPrincipal()

setResponsibilityId

public void setResponsibilityId(String responsibilityId)

setDocName

public void setDocName(String docName)

setActionRequestCd

public void setActionRequestCd(String actionRequestCd)

setDateAssigned

public void setDateAssigned(Timestamp dateAssigned)

setPrincipalId

public void setPrincipalId(String principalId)

setDocumentId

public void setDocumentId(String documentId)

setId

public void setId(String id)

setActionRequestId

public void setActionRequestId(String actionRequestId)

setDocHandlerURL

public void setDocHandlerURL(String docHandlerURL)

setGroupId

public void setGroupId(String groupId)

setDocLabel

public void setDocLabel(String docLabel)

setDocTitle

public void setDocTitle(String docTitle)

setRoleName

public void setRoleName(String roleName)

setDelegatorPrincipalId

public void setDelegatorPrincipalId(String delegatorPrincipalId)

setDelegatorGroupId

public void setDelegatorGroupId(String delegatorGroupId)

setDelegationType

public void setDelegationType(DelegationType delegationType)

setRequestLabel

public void setRequestLabel(String requestLabel)

getActionItemIndex

@Deprecated
public Integer getActionItemIndex()

Deprecated.

Description copied from interface: ActionItemContract

This method should never be called, has been deprecated, and will always return null. It was mistakenly added to this interface when it was created and has been left here for compatibility purposes.

Specified by:

getActionItemIndex in interface ActionItemContract

Returns:

always returns null

toString

public String toString()

Overrides:

toString in class Object

getRouteHeaderRouteStatus

public String getRouteHeaderRouteStatus()

getRouteHeaderCombinedStatus

public String getRouteHeaderCombinedStatus()

getRouteHeaderCreateDate

public Timestamp getRouteHeaderCreateDate()

getRouteHeaderInitiatorName

public String getRouteHeaderInitiatorName()

getRouteHeaderApprovedDate

public Timestamp getRouteHeaderApprovedDate()

getRouteHeaderCurrentRouteLevelName

public String getRouteHeaderCurrentRouteLevelName()

getRouteHeaderInitiatorWorkflowId

public String getRouteHeaderInitiatorWorkflowId()

getActionListIndex

public Integer getActionListIndex()

setActionListIndex

public void setActionListIndex(Integer actionListIndex)

getLastApprovedDate

public Timestamp getLastApprovedDate()

getCustomActions

public Map<String,String> getCustomActions()

setCustomActions

public void setCustomActions(Map<String,String> customActions)

getRowStyleClass

public String getRowStyleClass()

setRowStyleClass

public void setRowStyleClass(String rowStyleClass)

getDelegatorName

public String getDelegatorName()

getGroupName

public String getGroupName()

initialize

public void initialize(Preferences preferences)

getDisplayParameters

public DisplayParameters getDisplayParameters()

setDisplayParameters

public void setDisplayParameters(DisplayParameters displayParameters)

getRouteHeader

public DocumentRouteHeaderValue getRouteHeader()

setRouteHeader

public void setRouteHeader(DocumentRouteHeaderValue routeHeader)

getMinimalRouteHeader

public DocumentRouteHeaderValue getMinimalRouteHeader()

deepCopy

protected <T extends ActionItemBase> T deepCopy(Map<Object,Object> visited,
                                                Class<T> type)

getTarget

public String getTarget()

Called from ActionList.jsp to help determine the 'target' value when building the URL.

Returns:

the value from the DOC_SEARCH_TARGET policy if it exists for this document type