All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.face.ProjectPage

java.lang.Object
   |
   +----icc.face.Presenter
           |
           +----icc.face.ProjectPage

public final class ProjectPage

extends Presenter

See Also:

Project, Phase

ADMIN

A useful constant to specify an additional overview field.

NAME

A useful constant to specify an additional overview field.

TYPE

A useful constant to specify an additional overview field.

ProjectPage(Client, Handler, String, String)

Allocates an ProjectPage object for the specified client applet and handler and with the specified display name and url.

administrator()

Returns the current project administrator.

administrator(Integer)

Returns the administrator of the specified project.

documents()

Returns an array of document identifiers corresponding to the top-level documents in the project support folder.

editOn()

Returns whether this information is being edited or not.

getActualEndTime(String)

Returns the actual end date for the specified phase.

getActualStartTime(String)

Returns the actual start date for the specified phase.

getDocument(Integer)

Returns the document information for the specified identifier.

getFolder()

Returns the project support folder.

getMembers(Integer)

Returns an array of team members for the specified team.

getModificationTime()

Returns the last modification date of this project, in milliseconds since January 1, 1970, 00:00:00.

getOverview()

Returns the additional overview field name.

getPartnerFunction(Integer)

Returns the specified partner's function.

getPartnerFunction(Integer, Integer)

Returns the given partner's function in the specified project.

getPhaseStatus(String)

Returns the status for the specified phase.

getPlannedEndTime(String)

Returns the planned end date for the specified phase.

getPlannedStartTime(String)

Returns the planned start date for the specified phase.

getProjectId()

Returns the current project identifier.

getProjectMembers(Integer)

Returns an array of team members for the specified team, that are project partners for the current project.

getProjectName()

Returns the current project name.

getProjectName(Integer)

Returns the name of the specified project.

getProjectTitle()

Returns the current project title.

getProjectTitle(Integer)

Returns the title of the specified project.

getProjectType()

Returns the current project type.

getProjectType(Integer)

Returns the type of the specified project.

getUsername(Integer)

Returns the username of the specified partner.

isEditable()

Checks whether this project is editable, i.e., whether the user is the project administrator.

isProjectMember(Integer)

Checks if the specified partner is a member of the current project.

overviews()

Returns an array of valid overview field names.

parent()

Returns the parent project name.

partnerNames()

Returns an array of all partners' usernames.

phaseNames()

Returns an array of phase names for the current project.

removePartner(Integer)

Removes the specified partner from this project.

removePhase(String)

Removes the specified phase from the current project, if this project is being edited.

renamePhase(String, String)

Renames the specified phase of the current project, if this project is being edited.

setActualEndTime(String, long)

Sets the actual end date for the specified phase, if the corresponding project is being edited.

setActualStartTime(String, long)

Sets the actual start date for the specified phase, if the corresponding project is being edited.

setNewProject(String, Integer)

Sets a new project to be the current project.

setOverview(String)

Sets the current overview field name.

setPartner(Integer, String)

Adds the specified partner to this project with the specified function.

setPhase(String)

Adds the specified phase to the current project, if this project is being edited.

setPhaseStatus(String, int)

Sets the status for the specified phase, if the corresponding project is being edited.

setPlannedEndTime(String, long)

Sets the planned end date for the specified phase, if the corresponding project is being edited.

setPlannedStartTime(String, long)

Sets the planned start date for the specified phase, if the corresponding project is being edited.

setProject(Integer)

Sets the current project.

setProjectAdministrator(String)

Sets the current project administrator, if this project is being edited.

setProjectTitle(String)

Sets the current project title, if this project is being edited.

setProjectType(String)

Sets the current project type, if this project is being edited.

submit()

subprojects(Integer)

Returns a list of projects that have the specified project as their parent.

teams()

Returns an array of teams.

toggleEdit()

Toggles whether this information is being edited or not.

 public final String NAME

A useful constant to specify an additional overview field.

 public final String TYPE

A useful constant to specify an additional overview field.

 public final String ADMIN

A useful constant to specify an additional overview field.

 public ProjectPage(Client client,
                    Handler handler,
                    String display,
                    String url)

Allocates an ProjectPage object for the specified client applet and handler and with the specified display name and url.

Parameters:

client - the client applet

handler - the client handler

display - a display name

url - a url to be published in this display

 public Integer getProjectId()

Returns the current project identifier.

Returns:

a project identifier

 public String getProjectName()

Returns the current project name.

Returns:

a project name

 public String getProjectTitle()

Returns the current project title.

Returns:

a project title

 public String getProjectType()

Returns the current project type.

Returns:

a project type

 public Integer administrator()

Returns the current project administrator.

Returns:

a partner identifier

 public String parent()

Returns the parent project name.

Returns:

a project name

 public long getModificationTime()

Returns the last modification date of this project, in milliseconds since January 1, 1970, 00:00:00.

Returns:

the number of milliseconds since January 1, 1970, 00:00:00

 public String[] overviews()

Returns an array of valid overview field names.

 public String getOverview()

Returns the additional overview field name.

Returns:

an overview field name

 public String getProjectName(Integer id)

Returns the name of the specified project.

Parameters:

id - a project identifier

Returns:

the project name

 public String getProjectTitle(Integer id)

Returns the title of the specified project.

Parameters:

id - a project identifier

Returns:

the project title

 public String getProjectType(Integer id)

Returns the type of the specified project.

Parameters:

id - a project identifier

Returns:

the project type

 public Integer administrator(Integer id)

Returns the administrator of the specified project.

Parameters:

id - a project identifier

Returns:

the partner identifier

 public Integer[] subprojects(Integer id)

Returns a list of projects that have the specified project as their parent.

Parameters:

id - a project identifier

Returns:

an array of project identifiers

 public String getPartnerFunction(Integer id,
                                  Integer partnerid)

Returns the given partner's function in the specified project. If the specified partner is not a project partner, null is returned.

Parameters:

id - a project identifier

partnerid - a partner identifier

Returns:

a partner function

 public String getPartnerFunction(Integer partnerid)

Returns the specified partner's function. If the specified partner is not a project partner, null is returned.

Parameters:

partnerid - a partner identifier

Returns:

a partner function

 public void setOverview(String field)

Sets the current overview field name. If the field name is null no additional overview field should be shown.

Parameters:

field - an overview field name

See Also:

NAME, TYPE, ADMIN

 public String[] phaseNames()

Returns an array of phase names for the current project.

Returns:

an array of phase names

 public long getPlannedStartTime(String name)

Returns the planned start date for the specified phase.

Parameters:

name - a phase name

Returns:

the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the planned start date.

 public long getPlannedEndTime(String name)

Returns the planned end date for the specified phase.

Parameters:

name - a phase name

Returns:

the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the planned end date.

 public long getActualStartTime(String name)

Returns the actual start date for the specified phase.

Parameters:

name - a phase name

Returns:

the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the actual start date.

 public long getActualEndTime(String name)

Returns the actual end date for the specified phase.

Parameters:

name - a phase name

Returns:

the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the actual end date.

 public int getPhaseStatus(String name)

Returns the status for the specified phase.

Parameters:

name - a phase name

Returns:

phase status as a percentage completed work

 public Folder getFolder()

Returns the project support folder.

Returns:

a folder

 public Integer[] documents()

Returns an array of document identifiers corresponding to the top-level documents in the project support folder.

Returns:

an array of document identifiers

 public Header getDocument(Integer id)

Returns the document information for the specified identifier.

Parameters:

id - a document identifier

Returns:

a document

 public void setProject(Integer id)

Sets the current project.

Parameters:

id - a project identifier

 public void setNewProject(String name,
                           Integer id)

Sets a new project to be the current project. The parent project must be specified too.

Parameters:

name - a project name

id - a project identifier

 public void setProjectTitle(String title)

Sets the current project title, if this project is being edited.

Parameters:

title - a project title

 public void setProjectType(String type)

Sets the current project type, if this project is being edited.

Parameters:

type - a project type

 public void setProjectAdministrator(String username)

Sets the current project administrator, if this project is being edited.

Parameters:

username - a partner username

 public void removePartner(Integer id)

Removes the specified partner from this project.

Parameters:

id - a partner identifier

 public void setPartner(Integer id,
                        String function)

Adds the specified partner to this project with the specified function.

Parameters:

id - a partner identifier

function - a function name

 public void removePhase(String name)

Removes the specified phase from the current project, if this project is being edited.

Parameters:

name - a phase name

 public void setPhase(String name)

Adds the specified phase to the current project, if this project is being edited. The current date is assigned as default start date and end dates.

Parameters:

name - a phase name

 public void renamePhase(String oldname,
                         String newname)

Renames the specified phase of the current project, if this project is being edited.

Parameters:

oldname - an existing phase name

newname - a new phase name

 public void setPlannedStartTime(String name,
                                 long time)

Sets the planned start date for the specified phase, if the corresponding project is being edited.

Parameters:

name - a phase name

time - the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the planned start date.

 public void setPlannedEndTime(String name,
                               long time)

Sets the planned end date for the specified phase, if the corresponding project is being edited.

Parameters:

name - a phase name

time - the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the planned end date.

 public void setActualStartTime(String name,
                                long time)

Sets the actual start date for the specified phase, if the corresponding project is being edited.

Parameters:

name - a phase name

time - the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the actual start date.

 public void setActualEndTime(String name,
                              long time)

Sets the actual end date for the specified phase, if the corresponding project is being edited.

Parameters:

name - a phase name

time - the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the actual end date.

 public void setPhaseStatus(String name,
                            int status)

Sets the status for the specified phase, if the corresponding project is being edited.

Parameters:

name - a phase name

status - a phase status as a percentage completed work

 public boolean isEditable()

Checks whether this project is editable, i.e., whether the user is the project administrator.

Returns:

true if this information editable, false otherwise.

 public boolean editOn()

Returns whether this information is being edited or not.

Returns:

true if this information is being edited, false otherwise.

 public void toggleEdit()

Toggles whether this information is being edited or not.

 public Integer[] teams()

Returns an array of teams.

Returns:

an array of team identifiers

 public Integer[] getMembers(Integer id)

Returns an array of team members for the specified team.

Returns:

an array of team member identifiers

 public Integer[] getProjectMembers(Integer id)

Returns an array of team members for the specified team, that are project partners for the current project.

Returns:

an array of team member identifiers

 public String[] partnerNames()

Returns an array of all partners' usernames.

Returns:

an array of usernames

 public String getUsername(Integer id)

Returns the username of the specified partner.

Parameters:

id - a partner identifier

Returns:

a partner username

 public boolean isProjectMember(Integer id)

Checks if the specified partner is a member of the current project.

Parameters:

id - a partner identifier

Returns:

true if the partner is a member of the project, false otherwise

 public void submit()

All Packages  Class Hierarchy  This Package  Previous  Next  Index