All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Phase 

java.lang.Object
   |
   +----icc.db.Phase
public class Phase
extends Object
implements Serializable
The Phase class represents a project phase, corresponding to a specification on the 'time' axis of the project data space. As such, a phase is uniquely defined by a project identifier and a time specifier. Other information includes a start and end date, a planned start and end date and a status of completed work (as a percentage).

See Also:
Project

Constructor Index

o Phase(Integer, String, Date, Date)
Allocates a Phase object with the specified project identifier, name, and planned start and end date.

Method Index

o actualEnd()
Returns the end date of this phase as a string.
o actualStart()
Returns the start date of this phase as a string.
o alter()
Creates a data request to alter the information of this phase in the database.
o clear()
Removes all Phase objects previously put.
o end()
Returns the end date of this phase.
o get(Integer)
Retrieves an array of phase information for the specified project, if previously put.
o get(Integer, String)
Retrieves the Phase object for the specified project identifier and project time specifier, if previously put.
o name()
Returns the phase name.
o planEnd()
Returns the planned end date of this phase.
o plannedEnd()
Returns the planned end date of this phase as a string.
o plannedStart()
Returns the planned start date of this phase as a string.
o planStart()
Returns the planned start date of this phase.
o project()
Returns the project identifier of this phase.
o put()
Stores this object for later retrieval by project identifier and name.
o remove()
Removes this object from local storage, if previously put.
o remove(Integer, String)
Removes the Phase object with the specified project identifier and project time specifier previously put, if any.
o replace(Integer, Phase[])
Replaces all phase information for the specified project with the specified phases.
o retrieve(Integer)
Creates a data request to retrieve an array of phase information for the specified project.
o setEnd(Date)
Sets the actual end date of this phase.
o setStart(Date)
Sets the actual start date of this phase.
o setStatus(int)
Sets the status of this phase.
o start()
Returns the start date of this phase.
o status()
Returns the status of this phase, as a percentage of completed work.
o update(Integer, Phase[])
Creates a data request to update the phase information for the specified project.

Constructors

o Phase 
 public Phase(Integer project,
              String name,
              Date start,
              Date end)
Allocates a Phase object with the specified project identifier, name, and planned start and end date. These dates are also assigned as current start and end date. The current status is set to 0.

Parameters:
project - a project identifier
name - a time specifier
start - the planned start date
end - the planned end date

Methods

o project 
 public Integer project()
Returns the project identifier of this phase.

Returns:
a project identifier
o name 
 public String name()
Returns the phase name. This is a project time identifier.

Returns:
a time identifier
See Also:
Project
o start 
 public Date start()
Returns the start date of this phase.

Returns:
the start date
o end 
 public Date end()
Returns the end date of this phase.

Returns:
the end date
o actualStart 
 public String actualStart()
Returns the start date of this phase as a string.

Returns:
a date string
o actualEnd 
 public String actualEnd()
Returns the end date of this phase as a string.

Returns:
a date string
o planStart 
 public Date planStart()
Returns the planned start date of this phase.

Returns:
the planned start date
o planEnd 
 public Date planEnd()
Returns the planned end date of this phase.

Returns:
the planned end date
o plannedStart 
 public String plannedStart()
Returns the planned start date of this phase as a string.

Returns:
a date string
o plannedEnd 
 public String plannedEnd()
Returns the planned end date of this phase as a string.

Returns:
a date string
o status 
 public int status()
Returns the status of this phase, as a percentage of completed work.

Returns:
an integer percentage
o setStart 
 public void setStart(Date start)
Sets the actual start date of this phase. Altering phase information has no actual effect until this information is updated in the database.

Parameters:
start - the actual start date
See Also:
alter, update
o setEnd 
 public void setEnd(Date end)
Sets the actual end date of this phase. Altering phase information has no actual effect until this information is updated in the database.

Parameters:
end - the actual end date
See Also:
alter, update
o setStatus 
 public void setStatus(int status)
Sets the status of this phase. Altering phase information has no actual effect until this information is updated in the database.

Parameters:
status - an integer percentage
See Also:
alter, update
o get 
 public static Phase get(Integer id,
                         String name)
Retrieves the Phase object for the specified project identifier and project time specifier, if previously put.

Parameters:
id - a project identifier
name - a project time specifier
Returns:
the corresponding phase information, if known; otherwise null
o get 
 public static Phase[] get(Integer id)
Retrieves an array of phase information for the specified project, if previously put.

Parameters:
id - a project identifier
Returns:
a corresponding array of phase information, if known; otherwise null
o put 
 public void put()
Stores this object for later retrieval by project identifier and name.

o remove 
 public void remove()
Removes this object from local storage, if previously put.

o remove 
 public static Phase remove(Integer id,
                            String name)
Removes the Phase object with the specified project identifier and project time specifier previously put, if any.

Parameters:
id - a project identifier
name - a project time specifier
Returns:
the object in question, if any; otherwise null
o clear 
 public static void clear()
Removes all Phase objects previously put.

o replace 
 public static void replace(Integer id,
                            Phase phar[])
Replaces all phase information for the specified project with the specified phases.

Parameters:
id - a project identifier
phar - an array of phase information for a project
o retrieve 
 public static DataRequest retrieve(Integer id)
Creates a data request to retrieve an array of phase information for the specified project.

Parameters:
id - a project identifier
Returns:
a data request to retrieve an array of phase information
See Also:
SERVICE
o alter 
 public DataRequest alter()
Creates a data request to alter the information of this phase in the database. Only the project administrator can submit this request. If successful, an appropriate event is posted.

Returns:
a data request to alter phase information
See Also:
SERVICE
o update 
 public static DataRequest update(Integer project,
                                  Phase phases[])
Creates a data request to update the phase information for the specified project. Only the project administrator can submit this request. If successful, an appropriate event is posted.

Parameters:
project - a project identifier
phases - the phases information
Returns:
a data request to update all project phase information
See Also:
SERVICE 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

This website has been archived and is no longer maintained.