org.kuali.kra.protocol.customdata

Class ProtocolCustomDataHelperBase<T extends DocumentCustomData>

java.lang.Object

org.kuali.kra.common.customattributes.CustomDataHelperBase<T>

org.kuali.kra.protocol.customdata.ProtocolCustomDataHelperBase<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CustomDataHelper, IacucProtocolCustomDataHelper

public abstract class ProtocolCustomDataHelperBase<T extends DocumentCustomData>
extends CustomDataHelperBase<T>

The CustomDataHelper is used to manage the Custom Data tab web page. It contains the data, forms, and methods needed to render the page.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.kra.common.customattributes.CustomDataHelperBase

CustomDataHelperBase.LabelComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected ProtocolFormBase	form Each Helper must contain a reference to its document form so that it can access the document.

Constructor Summary

Constructors

Constructor and Description
ProtocolCustomDataHelperBase(ProtocolFormBase form) Constructs a CustomDataHelper.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDisplayCustomDataTab() This method returns true if the custom data tab should be displayed.
abstract boolean	canModifyCustomData() Can the current user modify the custom data values?
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected String	getDocumentTypeCode()
protected ProtocolBase	getProtocol()
protected TaskAuthorizationService	getTaskAuthorizationService()

Methods inherited from class org.kuali.kra.common.customattributes.CustomDataHelperBase

buildCustomDataCollectionsOnExistingDocument, buildCustomDataCollectionsOnNewDocument, getCustomAttributeDocuments, getCustomAttributeGroups, getCustomAttributeService, getCustomDataList, getModifyCustomData, getNewCustomData, getUserIdentifier, getValidCustomAttributeGroupName, initializePermissions, prepareCustomData, setCustomAttributeContent, setCustomAttributeGroups

Methods inherited from class java.lang.Object

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

Field Detail

form

protected ProtocolFormBase form

Each Helper must contain a reference to its document form so that it can access the document.

Constructor Detail

ProtocolCustomDataHelperBase

public ProtocolCustomDataHelperBase(ProtocolFormBase form)

Constructs a CustomDataHelper.

Parameters:

form - the form

Method Detail

getProtocol

protected ProtocolBase getProtocol()

canDisplayCustomDataTab

public boolean canDisplayCustomDataTab()

This method returns true if the custom data tab should be displayed.

Returns:

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

canModifyCustomData

public abstract boolean canModifyCustomData()

Can the current user modify the custom data values?

Overrides:

canModifyCustomData in class CustomDataHelperBase<T extends DocumentCustomData>

Returns:

true if can modify the custom data; otherwise false

getTaskAuthorizationService

protected TaskAuthorizationService getTaskAuthorizationService()

Overrides:

getTaskAuthorizationService in class CustomDataHelperBase<T extends DocumentCustomData>

getDocumentTypeCode

protected String getDocumentTypeCode()