org.kuali.kpme.tklm.api.time.timeblock.web

Interface TimeBlockRendererContract

All Known Implementing Classes:

TimeBlockRenderer

public interface TimeBlockRendererContract

TimeBlockRendererContract interface

Method Summary

Methods

Modifier and Type	Method and Description
String	getAmount() The amount of the TimeBlock object associated with the TimeBlockRenderer
String	getAssignmentClass() The assignmentClass associated with the TimeBlockRenderer
List<? extends TimeHourDetailRendererContract>	getDetailRenderers() The list of TimeHourDetailRenderer objects associated with the TimeBlockRenderer
String	getEarnCodeType() The earn code type of the TimeBlock object associated with the TimeBlockRenderer
String	getLunchLabel() TODO: Put a better comment The lunchLabel associated with the TimeBlockRenderer
String	getLunchLabelId() TODO: Put a better comment The lunchLabelId associated with the TimeBlockRenderer
TimeBlockContract	getTimeBlock() The TimeBlock object associated with the TimeBlockRenderer
String	getTimeRange() The time range associated with the TimeBlockRenderer
String	getTitle() The title associated with the TimeBlockRenderer

Method Detail

getDetailRenderers

List<? extends TimeHourDetailRendererContract> getDetailRenderers()

The list of TimeHourDetailRenderer objects associated with the TimeBlockRenderer

detailRenderers for a TimeBlockRenderer

Returns:

detailRenderers for TimeBlockRenderer

getTimeBlock

TimeBlockContract getTimeBlock()

The TimeBlock object associated with the TimeBlockRenderer

timeBlock for a TimeBlockRenderer

Returns:

timeBlock for TimeBlockRenderer

getTimeRange

String getTimeRange()

The time range associated with the TimeBlockRenderer

If timeBlock's earn code type is T, construct a string (begin time in hh:mm aa format - end time in hh:mm aa format)

Returns:

a string representation of time range for TimeBlockRenderer

getTitle

String getTitle()

The title associated with the TimeBlockRenderer

Constructs a title string based on work area description and task description

Returns:

work area description - task description if task is not the default one

getAmount

String getAmount()

The amount of the TimeBlock object associated with the TimeBlockRenderer

If timeBlock's earn code type is A If timeBlock's amount is not null, "A: $x.xx" else "A: $0.00" Else ""

Returns:

"A: $x.xx" if timeBlock's amount is not null, "A: $0.00" if null, "" if earn code type is not A

getEarnCodeType

String getEarnCodeType()

The earn code type of the TimeBlock object associated with the TimeBlockRenderer

timeBlock.getEarnCodeType() for a TimeBlockRenderer

Returns:

timeBlock.getEarnCodeType() for TimeBlockRenderer

getAssignmentClass

String getAssignmentClass()

The assignmentClass associated with the TimeBlockRenderer

assignmentClass for a TimeBlockRenderer

Returns:

assignmentClass for TimeBlockRenderer

getLunchLabel

String getLunchLabel()

TODO: Put a better comment The lunchLabel associated with the TimeBlockRenderer

lunchLabel for a TimeBlockRenderer

Returns:

lunchLabel for TimeBlockRenderer

getLunchLabelId

String getLunchLabelId()

TODO: Put a better comment The lunchLabelId associated with the TimeBlockRenderer

lunchLabelId for a TimeBlockRenderer

Returns:

lunchLabelId for TimeBlockRenderer