org.kuali.kra.common.customattributes

Class CustomDataHelperBase<T extends DocumentCustomData>

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CustomDataHelper, CustomDataHelper, CustomDataHelper, CustomDataHelper, InstitutionalProposalCustomDataFormHelper, ProposalDevelopmentCustomDataHelper, ProtocolCustomDataHelperBase

public abstract class CustomDataHelperBase<T extends DocumentCustomData>
extends Object
implements Serializable

The CustomDataHelperBase is the base class for all Custom Data Helper classes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CustomDataHelperBase.LabelComparator Sorts custom data attributes by label for alphabetical order on custom data panels.

Constructor Summary

Constructors

Constructor and Description
CustomDataHelperBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	buildCustomDataCollectionsOnExistingDocument(SortedMap<String,List> customAttributeGroups) This method builds the custom data collections used on the form and populates the values from the collection of AwardCustomData on the Award.
void	buildCustomDataCollectionsOnNewDocument(SortedMap<String,List> customAttributeGroups) This method builds the custom data collections used on the form
boolean	canModifyCustomData() Can the current user modify the custom data values?
abstract Map<String,CustomAttributeDocument>	getCustomAttributeDocuments()
Map<String,List>	getCustomAttributeGroups() Gets the customAttributeGroups attribute.
protected CustomAttributeService	getCustomAttributeService()
abstract List<T>	getCustomDataList()
boolean	getModifyCustomData() Get the ModifyCustomData value.
protected abstract T	getNewCustomData()
protected TaskAuthorizationService	getTaskAuthorizationService()
protected String	getUserIdentifier() Get the userName of the user for the current session.
String	getValidCustomAttributeGroupName(String groupName) This method takes in a groupName from the data entry and return a valid string to use in the Map functions later.
void	initializePermissions() Initialize the permissions for viewing/editing the Custom Data web page.
void	prepareCustomData()
void	setCustomAttributeContent(String documentNumber, String attributeName) Set the custom attribute content in workflow.
void	setCustomAttributeGroups(SortedMap<String,List> customAttributeGroups) Sets the customAttributeGroups attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDataHelperBase

public CustomDataHelperBase()

Method Detail

buildCustomDataCollectionsOnExistingDocument

public void buildCustomDataCollectionsOnExistingDocument(SortedMap<String,List> customAttributeGroups)

This method builds the custom data collections used on the form and populates the values from the collection of AwardCustomData on the Award.

Parameters:

customAttributeGroups -

awardForm -

customAttributeDocuments -

buildCustomDataCollectionsOnNewDocument

public void buildCustomDataCollectionsOnNewDocument(SortedMap<String,List> customAttributeGroups)

This method builds the custom data collections used on the form

Parameters:

customAttributeGroups -

awardForm -

customAttributeDocuments -

prepareCustomData

public void prepareCustomData()

getNewCustomData

protected abstract T getNewCustomData()

getCustomDataList

public abstract List<T> getCustomDataList()

getCustomAttributeDocuments

public abstract Map<String,CustomAttributeDocument> getCustomAttributeDocuments()

getValidCustomAttributeGroupName

public String getValidCustomAttributeGroupName(String groupName)

This method takes in a groupName from the data entry and return a valid string to use in the Map functions later. Note, data entry may create a null group name, which is invalid with the Map funcitons.

Parameters:

groupName -

Returns:

initializePermissions

public void initializePermissions()

Initialize the permissions for viewing/editing the Custom Data web page.

canModifyCustomData

public boolean canModifyCustomData()

Can the current user modify the custom data values?

Returns:

true if can modify the custom data; otherwise false

getModifyCustomData

public boolean getModifyCustomData()

Get the ModifyCustomData value.

Returns:

the ModifyCustomData value

setCustomAttributeGroups

public void setCustomAttributeGroups(SortedMap<String,List> customAttributeGroups)

Sets the customAttributeGroups attribute value.

Parameters:

customAttributeGroups - The customAttributeGroups to set.

getCustomAttributeGroups

public Map<String,List> getCustomAttributeGroups()

Gets the customAttributeGroups attribute.

Returns:

Returns the customAttributeGroups.

getTaskAuthorizationService

protected TaskAuthorizationService getTaskAuthorizationService()

getUserIdentifier

protected String getUserIdentifier()

Get the userName of the user for the current session.

Returns:

the current session's userName

setCustomAttributeContent

public void setCustomAttributeContent(String documentNumber,
                             String attributeName)

Set the custom attribute content in workflow.

Parameters:

form -

Throws:

Exception

getCustomAttributeService

protected CustomAttributeService getCustomAttributeService()