All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.face.ControlPage

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

public class ControlPage

extends Presenter

For this purpose, it relies on both a selection folder and a selection cube.

A Folder specifies the project cube and selection criteria for the retrieval of documents. In addition, this control page provides two boolean toggles. The first one specifies whether all information or only the document headers should be retrieved for all document. The second one specifies whether more or fewer selection criteria should be shown in the interface.

A separate Cube allows for the specification of new project cubes.

See Also:

Project, Folder, Cube

ControlPage(Client, Handler, String, String)

Allocates a ControlPage object for the specified client applet and project with the specified display name and url.

fullDocuments()

Returns whether all information or only the document headers should be retrieved.

getNewProjectName()

Returns the new project name, if any.

getProjectId()

Returns the current project identifier.

getProjectName()

Returns the current project name.

getSelectionCube()

Returns the selection project cube.

getSelectionFolder()

Returns the folder with the current selection criteria defined.

isAdministrator()

Checks if the user is the administrator for the current project.

isAdministrator(String)

Checks if the user is the administrator for the specified project.

newArea()

Returns whether a new or an existing area is being specified.

newProject()

Returns whether a new or an existing project is being specified.

newTime()

Returns whether a new or an existing time is being specified.

newType()

Returns whether a new or an existing type is being specified.

partnerNames()

Returns an array of all partners' usernames.

projectAreas()

Returns an array of project area specifiers defined for the current project.

projectCubes()

Returns an array of project cubes including user access right.

projectNames()

Returns an array of project names defined.

projectTimes()

Returns an array of project time specifiers defined for the current project.

projectTypes()

Returns an array of project type specifiers defined for the current project.

retrieve()

Retrieves the document information with respect to the criteria.

setNewProjectName(String)

Sets a new project name.

setProjectName(String)

Sets the current project name.

setSelectionFolder(Folder)

Sets the folder with the current selection criteria defined to be the specified folder.

showMoreCriteria()

Returns whether more or fewer selection criteria should be shown.

toggleFull()

Toggles between all and headers only information retrieval.

toggleMore()

Toggles between more and fewer selection criteria to be shown.

toggleNewArea()

Toggles between a new or an existing area being specified.

toggleNewOff()

Sets for all three area, time and type that an existing specifier is to be retrieved.

toggleNewProject()

Toggles between a new or an existing project being specified.

toggleNewTime()

Toggles between a new or an existing time being specified.

toggleNewType()

Toggles between a new or an existing type being specified.

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

Allocates a ControlPage object for the specified client applet and project 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 String getProjectName()

Returns the current project name.

Returns:

a project name

 public Integer getProjectId()

Returns the current project identifier.

Returns:

a project identifier

 public String getNewProjectName()

Returns the new project name, if any.

Returns:

a new project name, null otherwise

 public Folder getSelectionFolder()

Returns the folder with the current selection criteria defined.

Returns:

the selection folder

 public boolean fullDocuments()

Returns whether all information or only the document headers should be retrieved.

Returns:

a boolean value

 public boolean showMoreCriteria()

Returns whether more or fewer selection criteria should be shown.

Returns:

a boolean value

 public Cube getSelectionCube()

Returns the selection project cube.

Returns:

the selection cube

 public boolean newProject()

Returns whether a new or an existing project is being specified.

Returns:

true if a new project is being specified, false otherwise

 public boolean newArea()

Returns whether a new or an existing area is being specified.

Returns:

true if a new area is being specified, false otherwise

 public boolean newTime()

Returns whether a new or an existing time is being specified.

Returns:

true if a new time is being specified, false otherwise

 public boolean newType()

Returns whether a new or an existing type is being specified.

Returns:

true if a new type is being specified, false otherwise

 public String[] projectNames()

Returns an array of project names defined.

Returns:

an array of project names

 public String[] projectAreas()

Returns an array of project area specifiers defined for the current project.

Returns:

an array of project area specifiers

 public String[] projectTimes()

Returns an array of project time specifiers defined for the current project.

Returns:

an array of project time specifiers

 public String[] projectTypes()

Returns an array of project type specifiers defined for the current project.

Returns:

an array of project type specifiers

 public Cube[] projectCubes()

Returns an array of project cubes including user access right. Returns null if no access right information is available.

Returns:

an array of project cube information

 public String[] partnerNames()

Returns an array of all partners' usernames.

Returns:

an array of usernames

 public boolean isAdministrator()

Checks if the user is the administrator for the current project.

Returns:

true if the user is the administrator, false otherwise

 public boolean isAdministrator(String name)

Checks if the user is the administrator for the specified project.

Parameters:

name - a project name

Returns:

true if the user is the administrator, false otherwise

 public void setProjectName(String name)

Sets the current project name. This name must be an existing project name.

Parameters:

name - a project name

 public void toggleFull()

Toggles between all and headers only information retrieval.

 public void toggleMore()

Toggles between more and fewer selection criteria to be shown.

 public void retrieve()

Retrieves the document information with respect to the criteria.

 public void setNewProjectName(String name)

Sets a new project name.

Parameters:

name - a project name

 public void toggleNewOff()

Sets for all three area, time and type that an existing specifier is to be retrieved.

 public void toggleNewProject()

Toggles between a new or an existing project being specified.

 public void toggleNewArea()

Toggles between a new or an existing area being specified.

 public void toggleNewTime()

Toggles between a new or an existing time being specified.

 public void toggleNewType()

Toggles between a new or an existing type being specified.

 public void setSelectionFolder(Folder folder)

Sets the folder with the current selection criteria defined to be the specified folder.

Parameters:

folder - a folder

All Packages  Class Hierarchy  This Package  Previous  Next  Index