All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Project

java.lang.Object
   |
   +----icc.db.Entity
           |
           +----icc.db.Project

public final class Project

extends Entity

A project is defined by a unique identifier, a unique short name, a title and project type, an administrator, a parent project (optional), and a three-dimensional organization of the project data space according to 'area', 'time' (phase) and 'type'.

The number and names of the corresponding area, time and type specifiers can be specified and modified by the project administrator only.

A Project object can also include a vector of project partners' identifiers and access rights for these partners. Access rights are defined with respect to a project cube, corresponding to an individual selection of area, time and type.

All changes to a Project object must be submitted to the project database before these will take effect. Note that only the project administrator can submit such changes successfully.

See Also:

Partner, Cube, Access, Phase

areas

The array of valid area specifiers.

ENTRY

The name of a service that updates project information in the database on request.

partnersTable

phases

An array of phases information.

QUERY

The name of a service that retrieves project information from the database on request.

reset

A request to reset all project information stored at the webtop level.

rights

A vector of access rights information.

times

The array of valid time specifiers.

types

The array of valid type specifiers.

Project(Integer, String, String, Action, String, Integer)

Project(String, String, Partner, String, Project)

Allocates a Project object with the specified name, title, administrator, project type and parent project.

access(Cube)

Returns the access rights with respect to the specified cube.

addPartner(Integer, Integer, String)

administrator()

Returns the identifier of the administrator of this project.

alter()

Creates a data request to update this project in the database.

alterAccess(Access)

Updates or adds access rights to the corresponding Project object.

alterPartners()

Creates a data request to update the partners of this project.

clean(String, Integer)

Clears all project information in this object.

clear()

Removes all Project objects previously put.

copy(Project)

Copies the specified project information into this object, leaving the access rights vector and phase array set to null.

create()

Creates a data request to create this subproject.

cubes()

Creates a data request to retrieve an array of cube information for this project.

description()

Returns the title of this project.

duplicate()

Duplicates this object, leaving the access rights vector and phase array set to null.

get(Integer)

Retrieves the Project object for the specified identifier, if previously put.

get(String)

Retrieves a project by name, if previously put.

getPartnerFunction(Integer)

Returns the specified partner's function.

mutationDate()

Returns the last modification date of this project.

mutationTime()

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

parent()

Returns the identifier of the parent of this project.

partners()

Returns an enumeration of all project partner identifiers.

partners(String)

Creates a data request to retrieve an array of all project teams and partners in the specified project.

partnersSize()

Returns the number of project partners.

permission(Cube, Integer)

Returns the access right with respect to the specified cube and partner.

put()

Stores this object for later retrieval by name or identifier.

remove()

Removes this object from local storage, if previously put.

remove(Integer)

Removes the Project object with the specified identifier previously put, if any.

removeCube(Cube)

Removes access rights for the specified cube from the corresponding Project object.

removePartner(Integer)

Removes the specified partner from this project.

removePartner(Integer, Integer)

Creates a data request to add a partner to this project.

retrieve(Integer)

Creates a data request to retrieve the project information for the specified project identifier.

retrieve(String)

Creates a data request to retrieve the project information for the specified project name.

retrieveAll(String)

Creates a data request to retrieve an array of project information for the specified project name and subprojects hereof.

rights()

Creates a data request to retrieve a vector of access rights information for this project.

setAdministrator(Integer)

Sets the project administrator.

setPartner(Integer, String)

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

setTitle(String)

Sets the project title.

setType(String)

Sets the project type.

title()

Returns the title of this project.

type()

Returns the type of this project.

 public static final String QUERY

The name of a service that retrieves project information from the database on request.

 public static final String ENTRY

The name of a service that updates project information in the database on request. This service only accepts requests submitted by the project administrator.

 public static final Request reset

A request to reset all project information stored at the webtop level. Though this information should always be identical to the information in the project database, upon certain administrative actions this may no longer be the case. A request to reset this information should only be submitted by the project administrator.

 Hashtable partnersTable

 public String areas[]

The array of valid area specifiers.

 public String times[]

The array of valid time specifiers.

 public String types[]

The array of valid type specifiers.

 public Vector rights

A vector of access rights information. These are Access objects. This vector may be null.

See Also:

Access

 public Phase phases[]

An array of phases information. These are Phase objects. This array may be null.

See Also:

Phase

 Project(Integer id,
         String name,
         String title,
         Action mutation,
         String type,
         Integer parent)

 public Project(String name,
                String title,
                Partner administrator,
                String type,
                Project parent)

Allocates a Project object with the specified name, title, administrator, project type and parent project. The project identifier is set to NEW.

Parameters:

name - the unique project name

title - the project title

administrator - the project administrator

type - the project type

parent - the parent project

Throws: NullPointerException

Occurs when any of the arguments is null.

See Also:

NEW

 public String title()

Returns the title of this project.

Returns:

a string

 public String description()

Returns the title of this project.

Returns:

a string

Overrides:

description in class Entity

 public Integer administrator()

Returns the identifier of the administrator of this project.

Returns:

a partner identifier

 public String mutationDate()

Returns the last modification date of this project.

Returns:

a date string

 public long mutationTime()

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 type()

Returns the type of this project.

Returns:

a string

 public Integer parent()

Returns the identifier of the parent of this project.

Returns:

a project identifier

 public String getPartnerFunction(Integer id)

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

Parameters:

id - a partner identifier

Returns:

a partner function name

See Also:

Partner

 public int partnersSize()

Returns the number of project partners.

Returns:

a number of project partners

 public Enumeration partners()

Returns an enumeration of all project partner identifiers. Use the Enumeration methods on the returned object to fetch the partner identifiers sequentially.

Returns:

an enumeration of partner identifiers

See Also:

Partner

 public void setTitle(String title)

Sets the project title. Altering this project information has no actual effect until this information is also updated in the database.

Parameters:

title - a project title

 public void setType(String type)

Sets the project type. Altering this project information has no actual effect until this information is also updated in the database.

Parameters:

type - a project type

 public void setAdministrator(Integer id)

Sets the project administrator. Altering this project information has no actual effect until this information is also updated in the database.

Parameters:

id - a project partner identifier

 public void removePartner(Integer id)

Removes the specified partner from this project.

Parameters:

id - a partner identifier

See Also:

Partner

 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

See Also:

Partner

 public static Access access(Cube cube)

Returns the access rights with respect to the specified cube.

Parameters:

cube - a project cube

Returns:

the access rights for this cube; null if either the project or access rights information are missing, or if no access rights are defined for this cube.

 public static char permission(Cube cube,
                               Integer partnerid)

Returns the access right with respect to the specified cube and partner.

Parameters:

cube - a project cube

partnerid - a partner identifier

Returns:

the access right for this cube and partner; UNKNOWN if either the project, project partners or access rights information are missing, or NULL if no access information is defined for this cube.

See Also:

UNKNOWN, NULL

 public Project duplicate()

Duplicates this object, leaving the access rights vector and phase array set to null.

Returns:

a copy of this object

 public void copy(Project from)

Copies the specified project information into this object, leaving the access rights vector and phase array set to null.

Parameters:

from - the project information to copy

 public void clean(String name,
                   Integer parent)

Clears all project information in this object. Sets the project name and parent project.

Parameters:

name - a project name

parent - a project identifier

 public static void alterAccess(Access access)

Updates or adds access rights to the corresponding Project object. If the respective cube also defines a new area, time or type specifier, the corresponding project information is updated as well. This method does nothing if the project information cannot be found.

Parameters:

access - access rights with respect to a project cube

 public static void removeCube(Cube cube)

Removes access rights for the specified cube from the corresponding Project object. If this removal results in an area, time or type specifier no longer to be valid, then the corresponding project information is updated as well. This method does nothing if the project or project access rights information cannot be found, or if no access rights are defined for this cube.

Parameters:

cube - a project cube

 public static Project get(Integer id)

Retrieves the Project object for the specified identifier, if previously put.

Parameters:

id - a project identifier

Returns:

the project corresponding this identifier, if known; otherwise null

 public static Project get(String name)

Retrieves a project by name, if previously put.

Parameters:

id - a project name

Returns:

the project corresponding this name, if known; otherwise null

 public void put()

Stores this object for later retrieval by name or identifier.

 public void remove()

Removes this object from local storage, if previously put.

 public static Project remove(Integer id)

Removes the Project object with the specified identifier previously put, if any.

Parameters:

id - a project identifier

Returns:

the object in question, if any; otherwise null

 public static void clear()

Removes all Project objects previously put.

 public static DataRequest retrieve(String name)

Creates a data request to retrieve the project information for the specified project name.

Parameters:

name - a project name

Returns:

a data request to retrieve project information

See Also:

SERVICE

 public static DataRequest retrieve(Integer id)

Creates a data request to retrieve the project information for the specified project identifier.

Parameters:

id - a project identifier

Returns:

a data request to retrieve project information

See Also:

SERVICE

 public static DataRequest retrieveAll(String name)

Creates a data request to retrieve an array of project information for the specified project name and subprojects hereof.

Parameters:

name - a project name

Returns:

a data request to retrieve an array of project information

See Also:

SERVICE

 public static DataRequest partners(String name)

Creates a data request to retrieve an array of all project teams and partners in the specified project. (Teams are only defined for a root project, i.e., a project that has no parent.)

Parameters:

name - a project name

Returns:

a data request to retrieve an array of project teams and partners

See Also:

Partner, Team, SERVICE

 public DataRequest cubes()

Creates a data request to retrieve an array of cube information for this project. Each cube also specifies the requester's access right and the number of documents residing in this cube.

Returns:

a data request to retrieve an array of cubes

See Also:

SERVICE

 public DataRequest rights()

Creates a data request to retrieve a vector of access rights information for this project.

Returns:

a data request to retrieve a vector of project access rights information

See Also:

rights, SERVICE

 static DataRequest addPartner(Integer id,
                               Integer partnerid,
                               String function)

 static DataRequest removePartner(Integer id,
                                  Integer partnerid)

Creates a data request to add a partner to this project. Only the project administrator can submit this request. If successful, an appropriate event is posted.

Parameters:

partnerid - a partner id

function - the partner's function

Returns:

a data request to add a partner to a project

See Also:

addProject, SERVICE, ProjectEvents

 public DataRequest alterPartners()

Creates a data request to update the partners of this project. Only the project administrator can submit this request. If successful, an appropriate event is posted.

Returns:

a data request to alter a project's partners

See Also:

SERVICE, ProjectEvents

 public DataRequest create()

Creates a data request to create this subproject. Only the parent project's administrator can submit this request. If successful, an appropriate event is posted.

Returns:

a data request to create a subproject

See Also:

SERVICE, ProjectEvents

 public DataRequest alter()

Creates a data request to update this project in the database. Only the project administrator can submit this request. If successful, an appropriate event is posted.

Returns:

a data request to alter a project

See Also:

SERVICE, ProjectEvents

All Packages  Class Hierarchy  This Package  Previous  Next  Index