All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.face.PartnersPage

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

public final class PartnersPage

extends Presenter

See Also:

Team, Partner

EMAIL

A useful constant to retrieve a partner's e-mail address, or specify an additional overview field.

FAX

A useful constant to retrieve a partner's office fax number, or specify an additional overview field.

FUNCTION

A useful constant to specify a new partner's function in this project, or specify an additional overview field.

LOCATION

A useful constant to retrieve a partner's location, or specify the team locations as the desired organization.

PASSWORD

A useful constant to specify a new partner's initial password.

PHONE

A useful constant to retrieve a partner's office phone number, or specify an additional overview field.

ROLE

A useful constant to specify the team roles as the desired organization.

WWW

A useful constant to retrieve a partner's WWW address, or specify an additional overview field.

PartnersPage(Client, Handler, String, String)

Allocates a PartnersPage object for the specified client applet and handler and with the specified display name and url.

addOn()

Returns whether members are being added to this team or not.

clearTags()

Clears all tags.

editNew()

Sets this information to a new partner or team being edited.

editOn()

Returns whether this information is being edited or not.

firstPartner(Integer)

Returns the first partner in the specified team, if any.

getFunction(Integer)

Returns the project function for the specified partner.

getOrganization()

Returns the current organization string.

getOverview()

Returns the additional overview field name.

getPartner()

Returns the current partner (or team) information.

getPartner(Integer)

Returns the partner information for the specified partner.

getPartnerId(String)

Returns the partner identifier corresponding the specified username.

getProject()

Returns the current project identifier.

getProjectName()

Returns the current project name.

getProjectTitle()

Returns the current project title.

getSelection()

Returns the current organizational selection string.

getSelections(String)

Returns an array of valid selection names for the specified organization.

getTeam()

Returns the current team information.

isEditable(Integer)

Returns whether the selected team or partner information is editable by the current user, i.e., whether the user is the project administrator or belongs to the selected team or is the selected partner.

isModifiable()

Checks whether the partner information is modifiable, i.e., whether the user is the project administrator.

isOpen(Integer)

Checks whether the specified team is shown including all team partners, or not.

isOpen(String)

Checks whether the specified selection is shown including all selection teams, or not.

isRootProject()

Checks if the current project is the root project.

isTagged(Integer)

Checks whether the specified partner is tagged or not.

isTeam()

Checks whether the current information concerns a team or partner.

lastPartner(Integer)

Returns the last partner in the specified team, if any.

nextPartner(Integer, Integer)

Returns the next partner in the specified team, if any.

nextTeam(String, Integer)

Returns the next team in the specified selection, if any.

overviews()

Returns an array of valid overview field names.

previousPartner(Integer, Integer)

Returns the previous partner in the specified team, if any.

previousTeam(String, Integer)

Returns the previous team in the specified selection, if any.

selections()

Returns an array of valid selection names for the current organization.

setOrganization(String)

Sets the current organization.

setOverview(String)

Sets the current overview field name.

setPartner(Integer)

Sets the current partner.

setProject(Integer)

Sets the current project.

setSelection(String)

Sets the current organizational selection.

setTeam(Integer)

Sets the current team.

submit()

Submits the edited partner information for confirmation to the project database.

submitAddition(Integer[])

Submits the new set of team members for confirmation to the project database.

submitRemoval()

Submits a request to the project database to remove the current partner from this team, or the current team from the database, if no current partner is selected.

tags()

Returns an array of all tagged partner identifiers.

teams(String)

Returns an array of team identifiers corresponding the specified selection.

toggleAdd()

Toggles whether this team is being added on or not.

toggleEdit()

Toggles whether this information is being edited or not.

toggleOpen(Integer)

Toggles whether the specified team is shown including all team partners, or not.

toggleOpen(String)

Toggles whether the specified selection is shown including all selection teams or not.

toggleTag(Integer)

Toggles whether the specified partner is tagged or not.

 public final String ROLE

A useful constant to specify the team roles as the desired organization.

 public final String LOCATION

A useful constant to retrieve a partner's location, or specify the team locations as the desired organization.

 public final String EMAIL

A useful constant to retrieve a partner's e-mail address, or specify an additional overview field.

 public final String WWW

A useful constant to retrieve a partner's WWW address, or specify an additional overview field. organization.

 public final String PHONE

A useful constant to retrieve a partner's office phone number, or specify an additional overview field.

 public final String FAX

A useful constant to retrieve a partner's office fax number, or specify an additional overview field. organization.

 public final String PASSWORD

A useful constant to specify a new partner's initial password. organization.

 public final String FUNCTION

A useful constant to specify a new partner's function in this project, or specify an additional overview field.

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

Allocates a PartnersPage 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 getProject()

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 Partner getPartner()

Returns the current partner (or team) information.

Returns:

a partner

 public boolean isTeam()

Checks whether the current information concerns a team or partner.

Returns:

true if a team is concerned, false otherwise

 public Team getTeam()

Returns the current team information.

Returns:

a team

 public String getSelection()

Returns the current organizational selection string.

Returns:

a selection name

 public String getOrganization()

Returns the current organization string.

Returns:

an organization name

 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 boolean editOn()

Returns whether this information is being edited or not.

Returns:

true if this information is being edited, false otherwise.

 public boolean addOn()

Returns whether members are being added to this team or not.

Returns:

true if this team is being added on, false otherwise.

 public void setProject(Integer id)

Sets the current project.

Parameters:

id - a project identifier

 public boolean isEditable(Integer id)

Returns whether the selected team or partner information is editable by the current user, i.e., whether the user is the project administrator or belongs to the selected team or is the selected partner.

Parameters:

id - a partner identifier

Returns:

true if this information is editable, false otherwise.

 public boolean isModifiable()

Checks whether the partner information is modifiable, i.e., whether the user is the project administrator.

Returns:

true if the partner information is modifiable, false otherwise.

 public Partner getPartner(Integer id)

Returns the partner information for the specified partner.

Parameters:

id - a partner identifier

Returns:

the partner information

 public String getFunction(Integer id)

Returns the project function for the specified partner.

Parameters:

id - a partner identifier

Returns:

the partner's project function

 public Integer getPartnerId(String username)

Returns the partner identifier corresponding the specified username.

Parameters:

username - a partner's username

Returns:

the partner identifier

 public void setPartner(Integer id)

Sets the current partner. This partner must belong to the current team.

Parameters:

id - a partner identifier

 public Integer[] teams(String selection)

Returns an array of team identifiers corresponding the specified selection.

 public void setTeam(Integer id)

Sets the current team. This team must belong to the current selection. The current partner is set to null.

Parameters:

id - a team identifier

 public String[] selections()

Returns an array of valid selection names for the current organization.

 public String[] getSelections(String organization)

Returns an array of valid selection names for the specified organization.

 public void setSelection(String selection)

Sets the current organizational selection. This selection must belong to the current organization. The current team and partner are set to null.

Parameters:

selection - a selection name

 public void setOrganization(String org)

Sets the current organization. The current selection, team and partner are set to null.

Parameters:

org - an organization name

See Also:

ROLE, LOCATION

 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:

EMAIL, WWW, PHONE, FAX

 public void toggleEdit()

Toggles whether this information is being edited or not.

 public void toggleAdd()

Toggles whether this team is being added on or not. This method fails if currently a partner is selected.

 public void editNew()

Sets this information to a new partner or team being edited.

 public boolean isTagged(Integer id)

Checks whether the specified partner is tagged or not.

Parameters:

id - a partner identifier

Returns:

true if the partner is tagged, false otherwise

 public void toggleTag(Integer id)

Toggles whether the specified partner is tagged or not.

Parameters:

id - a partner identifier

 public Integer[] tags()

Returns an array of all tagged partner identifiers.

Returns:

an array of partner identifiers

 public void clearTags()

Clears all tags.

 public boolean isOpen(Integer id)

Checks whether the specified team is shown including all team partners, or not.

Parameters:

id - a team identifier

Returns:

true if the team is open, false otherwise

 public boolean isOpen(String selection)

Checks whether the specified selection is shown including all selection teams, or not.

Parameters:

selection - a selection name

Returns:

true if the selection is open, false otherwise

 public void toggleOpen(Integer id)

Toggles whether the specified team is shown including all team partners, or not.

Parameters:

id - a team identifier

 public void toggleOpen(String selection)

Toggles whether the specified selection is shown including all selection teams or not.

Parameters:

selection - a selection name

 public Partner previousPartner(Integer team,
                                Integer id)

Returns the previous partner in the specified team, if any.

Parameters:

team - a team identifier

id - a partner identifier

Returns:

the resulting partner information; null otherwise.

 public Team previousTeam(String group,
                          Integer id)

Returns the previous team in the specified selection, if any.

Parameters:

group - a selection string

id - a team identifier

Returns:

the resulting team information; null otherwise.

 public Partner nextPartner(Integer team,
                            Integer id)

Returns the next partner in the specified team, if any.

Parameters:

team - a team identifier

id - a partner identifier

Returns:

the resulting partner information; null otherwise.

 public boolean isRootProject()

Checks if the current project is the root project.

Returns:

true if this is the root project, false otherwise

 public Team nextTeam(String group,
                      Integer id)

Returns the next team in the specified selection, if any.

Parameters:

group - a selection string

id - a team identifier

Returns:

the resulting team information; null otherwise.

 public Partner firstPartner(Integer team)

Returns the first partner in the specified team, if any.

Parameters:

team - a team identifier

Returns:

the resulting partner information; null otherwise.

 public Partner lastPartner(Integer team)

Returns the last partner in the specified team, if any.

Parameters:

team - a team identifier

Returns:

the resulting partner information; null otherwise.

 public boolean submit()

Submits the edited partner information for confirmation to the project database. If this information concerns a new partner, the partner's password must be specified as an attribute with type equal to PASSWORD. Additionally, the partner's function in this project may be specified as an attribute with type equal to FUNCTION. If any necessary information is missing or incomplete, the information is not submitted.

Returns:

true if the information is submitted; false otherwise

See Also:

PASSWORD, FUNCTION, alter, create, create

 public boolean submitAddition(Integer ids[])

Submits the new set of team members for confirmation to the project database.

Parameters:

ids - an array of new member identifiers, possibly including null values.

Returns:

true if the information is submitted; false otherwise

See Also:

addOn, alterTeam

 public boolean submitRemoval()

Submits a request to the project database to remove the current partner from this team, or the current team from the database, if no current partner is selected. If it concerns a partner, this partner will be removed from the project, unless this partner belongs to another team. Furthermore, this partner will be removed from the database unless this partner belongs to another project. If it concerns a team, this team cannot contain any partners. If the current information is being edited, this method will fail.

Returns:

true if the request is submitted; false otherwise

See Also:

alterTeam, removeProject, editOn

All Packages  Class Hierarchy  This Package  Previous  Next  Index