Package com.aspose.tasks

Class TimephasedData

java.lang.Object

com.aspose.tasks.TimephasedData

public class TimephasedData
extends Object

Represents a time phased data.

Constructor Summary

Constructors

Constructor	Description
TimephasedData()	Initializes a new instance of the TimephasedData class.

Method Summary

Modifier and Type	Method	Description
static TimephasedData	createCostTimephased(int uid, Date start, Date finish, double value, byte type)	Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.
static TimephasedData	createCostTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)	Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.
static TimephasedData	createUnitTimephased(int uid, Date start, Date finish, double units, byte type)	Creates and initializes a new instance of the TimephasedData class for unit-based time phased data of an assignment of a material resource.
static TimephasedData	createWorkTimephased(int uid, Date start, Date finish, double value, byte timeUnit, byte type)	Creates and initializes a new instance of the TimephasedData class for work-based time phased data.
Date	getFinish()	Gets the finish date of a time phased data period.
Date	getStart()	Gets the start date of a time phased data period.
byte	getTimephasedDataType()	Gets the type of a time phased data.
int	getUid()	Gets the unique identifier of a time phased data
byte	getUnit()	Gets the time unit of a time phased data period.
String	getValue()	Gets the value per unit of time for a time phased data period.
double	getValueToCost()	Gets double instance which represents string value of this object.
double	getValueToDuration()	Gets double instance which represents string value of this object.
double	getValueToUnits()	Gets double instance which represents string value of this object for unit-based time phased data.
void	setFinish(Date value)	Sets the finish date of a time phased data period.
void	setStart(Date value)	Sets the start date of a time phased data period.
void	setTimephasedDataType(byte value)	Sets the type of a time phased data.
void	setUid(int value)	Sets the unique identifier of a time phased data
void	setUnit(byte value)	Sets the time unit of a time phased data period.
void	setValue(String value)	Sets the value per unit of time for a time phased data period.
void	setValueToCost(double value)	double instance which represents string value of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimephasedData

public TimephasedData()

Initializes a new instance of the TimephasedData class.

Method Detail

createCostTimephased

public static TimephasedData createCostTimephased(int uid,
                                                  Date start,
                                                  Date finish,
                                                  double value,
                                                  byte timeUnit,
                                                  byte type)

Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.

Parameters:

uid - UID of the task.

start - start date-time.

finish - Finish date-time.

value - Cost value.

timeUnit - Time unit type.

type - Time-phased data type.

Returns:

A instance of the TimephasedData class for cost-based time phased data.

Throws:

com.aspose.ms.System.ArgumentException - If negative cost value was specified.

createCostTimephased

public static TimephasedData createCostTimephased(int uid,
                                                  Date start,
                                                  Date finish,
                                                  double value,
                                                  byte type)

Creates and initializes a new instance of the TimephasedData class for cost-based time phased data.

Parameters:

uid - UID of the task.

start - start date-time.

finish - Finish date-time.

value - Cost value.

type - Time-phased data type.

Returns:

A instance of the TimephasedData class for cost-based time phased data.

Throws:

com.aspose.ms.System.ArgumentException - If negative cost value was specified.

createUnitTimephased

public static TimephasedData createUnitTimephased(int uid,
                                                  Date start,
                                                  Date finish,
                                                  double units,
                                                  byte type)

Creates and initializes a new instance of the TimephasedData class for unit-based time phased data of an assignment of a material resource.

Parameters:

uid - UID of the task.

start - Start date-time.

finish - Finish date-time.

units - Number of units.

type - Time-phased data type.

Returns:

A instance of the TimephasedData class for cost-based time phased data.

Throws:

com.aspose.ms.System.ArgumentException - If negative amount of units was specified.

createWorkTimephased

public static TimephasedData createWorkTimephased(int uid,
                                                  Date start,
                                                  Date finish,
                                                  double value,
                                                  byte timeUnit,
                                                  byte type)

Creates and initializes a new instance of the TimephasedData class for work-based time phased data.

Parameters:

uid - UID of the task.

start - start date-time.

finish - Finish date-time.

value - Timespan value.

timeUnit - Time unit type.

type - Time-phased data type.

Returns:

A instance of the TimephasedData class for work-based time phased data.

Throws:

com.aspose.ms.System.ArgumentException - If negative work value was specified.

getFinish

public final Date getFinish()

Gets the finish date of a time phased data period.

Returns:

the finish date of a time phased data period.

setFinish

public final void setFinish(Date value)

Sets the finish date of a time phased data period.

Parameters:

value - the finish date of a time phased data period.

getStart

public final Date getStart()

Gets the start date of a time phased data period.

Returns:

the start date of a time phased data period.

setStart

public final void setStart(Date value)

Sets the start date of a time phased data period.

Parameters:

value - the start date of a time phased data period.

getTimephasedDataType

public final byte getTimephasedDataType()

Gets the type of a time phased data.

Value(getValue()/setValue(String)) property will be cleared, if it is not suitable for type, specified here.

Returns:

the type of a time phased data.

setTimephasedDataType

public final void setTimephasedDataType(byte value)

Sets the type of a time phased data.

Value(getValue()/setValue(String)) property will be cleared, if it is not suitable for type, specified here.

Parameters:

value - the type of a time phased data.

getUid

public final int getUid()

Gets the unique identifier of a time phased data

Returns:

the unique identifier of a time phased data

setUid

public final void setUid(int value)

Sets the unique identifier of a time phased data

Parameters:

value - the unique identifier of a time phased data

getUnit

public final byte getUnit()

Gets the time unit of a time phased data period.

Returns:

the time unit of a time phased data period.

setUnit

public final void setUnit(byte value)

Sets the time unit of a time phased data period.

Parameters:

value - the time unit of a time phased data period.

getValue

public final String getValue()

Gets the value per unit of time for a time phased data period.

Returns:

the value per unit of time for a time phased data period.

Throws:

TasksException - When value is incorrect for specified TimephasedDataType(getTimephasedDataType()/setTimephasedDataType(byte)) or have negative value.

setValue

public final void setValue(String value)

Sets the value per unit of time for a time phased data period.

Parameters:

value - the value per unit of time for a time phased data period.

Throws:

TasksException - When value is incorrect for specified TimephasedDataType(getTimephasedDataType()/setTimephasedDataType(byte)) or have negative value.

getValueToCost

public final double getValueToCost()

Gets double instance which represents string value of this object.

Returns:

a floating point representation of the object.

setValueToCost

public final void setValueToCost(double value)

double instance which represents string value of this object.

Parameters:

value - double instance which represents string value of this object.

getValueToDuration

public final double getValueToDuration()

Gets double instance which represents string value of this object.

Returns:

a time span representation of the object.

getValueToUnits

public final double getValueToUnits()

Gets double instance which represents string value of this object for unit-based time phased data.

Returns:

a floating point representation of this object.