org.mpxj

Interface FieldContainer

All Known Implementing Classes:

AbstractFieldContainer, ProjectProperties, Resource, ResourceAssignment, Task, TemporaryResourceAssignment

public interface FieldContainer

This interface is implemented by the Task and Resource classes. It defines the common methods used to set and retrieve field values using their identifiers.

Method Summary

Modifier and Type	Method and Description
void	addFieldListener(FieldListener listener) Add a listener to receive field events.
Object	get(FieldType field) Retrieve a field value.
Object	getCachedValue(FieldType field) Retrieve a field value.
List<Duration>	getTimephasedDurationValues(FieldType field, List<LocalDateTimeRange> ranges, TimeUnit units) Retrieve timephased data expressed as Duration values.
List<Number>	getTimephasedNumericValues(FieldType field, List<LocalDateTimeRange> ranges) Retrieve timephased data expressed as Number values.
void	removeFieldListener(FieldListener listener) Remove a listener.
void	set(FieldType field, Object value) Set a field value.

Method Detail

set

void set(FieldType field,
         Object value)

Set a field value.

Parameters:

field - field identifier

value - field value

get

Object get(FieldType field)

Retrieve a field value.

Parameters:

field - field identifier

Returns:

field value

getCachedValue

Object getCachedValue(FieldType field)

Retrieve a field value. Use the cached value. Do not attempt to calculate a value if the cached value is null.

Parameters:

field - field identifier

Returns:

field value

getTimephasedDurationValues

List<Duration> getTimephasedDurationValues(FieldType field,
                                           List<LocalDateTimeRange> ranges,
                                           TimeUnit units)

Retrieve timephased data expressed as Duration values.

Parameters:

field - type of timephased data to retrieve

ranges - time ranges over which the data is distributed

units - units to use for the timephased duration values

Returns:

list of Duration instances

getTimephasedNumericValues

List<Number> getTimephasedNumericValues(FieldType field,
                                        List<LocalDateTimeRange> ranges)

Retrieve timephased data expressed as Number values.

Parameters:

field - type of timephased data to retrieve

ranges - time ranges over which the data is distributed

Returns:

list of Number instances

addFieldListener

void addFieldListener(FieldListener listener)

Add a listener to receive field events.

Parameters:

listener - target listener

removeFieldListener

void removeFieldListener(FieldListener listener)

Remove a listener.

Parameters:

listener - target listener