org.netbeans.modules.bugtracking.spi

Interface IssueScheduleProvider<I>

Type Parameters:

I - the implementation specific issue type

public interface IssueScheduleProvider<I>

Provides access to scheduling data for a given task so that they can by used by the Tasks Dashboard facilities - filtering or grouping by schedule date.

Typically a bugtracking system make it possible to specify a date when an issue is due, but this doesn't have to be the same date as the user private date for which an Issue was scheduled to start work on.

It is up to the particular implementation if the values eventually match with corresponding remote repository fields or if they are merely handed locally as user private.

Note that an implementation of this interface is not mandatory for a NetBeans bugtracking plugin.

Since:

1.85

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ISSUE_SCHEDULE_CHANGED Issue schedule has changed.

Method Summary

Modifier and Type	Method and Description
Date	getDueDate(I i) Returns the due date or null if not provided (by the remote repository).
IssueScheduleInfo	getSchedule(I i) Returns the the schedule info describing the time period for which the Issue was scheduled to start work on.
void	setSchedule(I i, IssueScheduleInfo scheduleInfo) Sets the schedule info describing the time period for which the Issue was scheduled to start work on.

Field Detail

EVENT_ISSUE_SCHEDULE_CHANGED

static final String EVENT_ISSUE_SCHEDULE_CHANGED

Issue schedule has changed. Fire this on registered IssueProvider listeners in case changes were made plugin-internally and not via the setters on this interface.

Since:

1.85

See Also:

IssueProvider.addPropertyChangeListener(java.lang.Object, java.beans.PropertyChangeListener), Constant Field Values

Method Detail

setSchedule

void setSchedule(I i,
                 IssueScheduleInfo scheduleInfo)

Sets the schedule info describing the time period for which the Issue was scheduled to start work on.

Note that this is a different date as when the Issue is due to be finished.

Parameters:

i - an implementation specific issue instance

scheduleInfo - a ScheduleInfo describing the Issues scheduling

Since:

1.85

getDueDate

Date getDueDate(I i)

Returns the due date or null if not provided (by the remote repository).

Note that this is a different date as for when the Issue is scheduled.

Parameters:

i - an implementation specific issue instance

Returns:

the Issues due date

Since:

1.85

getSchedule

IssueScheduleInfo getSchedule(I i)

Returns the the schedule info describing the time period for which the Issue was scheduled to start work on.

Note that this is a different date as when the Issue is due to be finished.

Parameters:

i - an implementation specific issue instance

Returns:

the Issues schedule info

Since:

1.85