All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Cube 

java.lang.Object
   |
   +----icc.db.Cube
public class Cube
extends Object
implements Serializable
The Cube class represents a cubical unit space within a project's three-dimensional data space. The three axes of this space are denoted 'area', 'time' and 'type'. Any selection of appropriate area, time and type specifiers defines a project cube. These cubes serve as organizational placeholders for project documents.

Additionally, a cube can specify the number of documents residing in this project cube.

In relation to an owner, a cube can also specify the access right this owner has with respect to the documents in this cube. All access rights are stored and maintained in the project database. An access right specification in a Cube object must reflect on the actual access right as can be retrieved from the database. Changing the access right specification in a Cube object has no effect on the owner's actual access right. If the access right has not yet been retrieved from the database, the specified value should be UNKNOWN. Upon retrieval, if no access rights are defined in the database for this cube, the resulting value will be NULL. Other valid values are DELETE, WRITE, READ and NONE.

See Also:
Project, Partner

Variable Index

o DELETE
This access right provides the owner all permissions.
o documents
The document count variable.
o NONE
This access right provides the owner no permissions.
o NULL
This value specifies that no access rights are defined for this cube.
o permission
The access right variable.
o READ
This access right provides the owner read permission only.
o UNKNOWN
This value specifies that the access right is unknown at this time or place.
o WRITE
This access right provides the owner read and write, but no delete permission.

Constructor Index

o Cube(Cube, char)
Allocates a new Cube object with the same area, time and type specifiers as the specified object, but with different access right.
o Cube(Integer, String, String, String)
Allocates a Cube object with the specified area, time and type specifiers.
o Cube(Integer, String, String, String, char)
Allocates a Cube object with the specified area, time and type specifiers and access right.

Method Index

o area()
Returns the project area specifier corresponding this cube.
o clear()
Removes all project cubes previously put in relationship to documents.
o equals(Object)
Compares this object to the specified object.
o exists()
Checks if any access rights are defined for this cube.
o findFile(String)
Creates a data request to find and retrieve a document with the specified name with respect to this project cube.
o get(Integer)
Retrieves the project cube for the specified document, if previously put.
o getAccess()
Creates a data request to retrieve the access rights defined for this project cube.
o jsarea()
Returns the project area specifier corresponding this cube.
o jstime()
Returns the project time specifier corresponding this cube.
o jstype()
Returns the project type specifier corresponding this cube.
o mayDelete()
Checks if the cube's owner has delete permission
o mayRead()
Checks if the cube's owner has read permission
o mayWrite()
Checks if the cube's owner has write permission
o project()
Returns the project identifier corresponding this cube.
o put(Integer)
Stores this object for later retrieval as the project cube for the specified document.
o remove(Integer)
Removes the project cube previously put for the specified document, if any.
o setArea(String)
Sets the project area specifier for this cube.
o setProject(Integer)
Sets the project identifier for this cube.
o setTime(String)
Sets the project time specifier for this cube.
o setType(String)
Sets the project type specifier for this cube.
o time()
Returns the project time specifier corresponding this cube.
o type()
Returns the project type specifier corresponding this cube.

Variables

o NULL 
 public static final char NULL
This value specifies that no access rights are defined for this cube. This means that nobody has any permissions for this cube.

o NONE 
 public static final char NONE
This access right provides the owner no permissions.

o READ 
 public static final char READ
This access right provides the owner read permission only.

o WRITE 
 public static final char WRITE
This access right provides the owner read and write, but no delete permission.

o DELETE 
 public static final char DELETE
This access right provides the owner all permissions.

o UNKNOWN 
 public static final char UNKNOWN
This value specifies that the access right is unknown at this time or place.

o permission 
 public char permission
The access right variable.

o documents 
 public int documents
The document count variable.

Constructors

o Cube 
 public Cube(Integer id,
             String area,
             String time,
             String type,
             char permission)
Allocates a Cube object with the specified area, time and type specifiers and access right.

Parameters:
id - the project identifier
area - the project area specifier
time - the project time specifier
type - the project type specifier
permission - the owner's access right
o Cube 
 public Cube(Integer id,
             String area,
             String time,
             String type)
Allocates a Cube object with the specified area, time and type specifiers.

Parameters:
id - the project identifier
area - the project area specifier
time - the project time specifier
type - the project type specifier
o Cube 
 public Cube(Cube other,
             char permission)
Allocates a new Cube object with the same area, time and type specifiers as the specified object, but with different access right.

Parameters:
other - the original object
permission - the new owner's access right

Methods

o project 
 public Integer project()
Returns the project identifier corresponding this cube.

Returns:
a project identifier
o area 
 public String area()
Returns the project area specifier corresponding this cube.

Returns:
a project area string
o jsarea 
 public String jsarea()
Returns the project area specifier corresponding this cube. This method is accessible from JavaScript.

Returns:
a project area string
o time 
 public String time()
Returns the project time specifier corresponding this cube.

Returns:
a project time string
o jstime 
 public String jstime()
Returns the project time specifier corresponding this cube. This method is accessible from JavaScript.

Returns:
a project time string
o type 
 public String type()
Returns the project type specifier corresponding this cube.

Returns:
a project type string
o jstype 
 public String jstype()
Returns the project type specifier corresponding this cube. This method is accessible from JavaScript.

Returns:
a project type string
o mayDelete 
 public boolean mayDelete()
Checks if the cube's owner has delete permission

Returns:
true if the access right provides delete permission; false otherwise
o mayWrite 
 public boolean mayWrite()
Checks if the cube's owner has write permission

Returns:
true if the access right provides write permission; false otherwise
o mayRead 
 public boolean mayRead()
Checks if the cube's owner has read permission

Returns:
true if the access right provides read permission; false otherwise
o exists 
 public boolean exists()
Checks if any access rights are defined for this cube.

o setProject 
 public void setProject(Integer id)
Sets the project identifier for this cube.

Parameters:
id - a project identifier
o setArea 
 public void setArea(String area)
Sets the project area specifier for this cube.

Parameters:
area - a project area specifier
o setTime 
 public void setTime(String time)
Sets the project time specifier for this cube.

Parameters:
time - a project time specifier
o setType 
 public void setType(String type)
Sets the project type specifier for this cube.

Parameters:
type - a project type specifier
o equals 
 public boolean equals(Object object)
Compares this object to the specified object. The result is true if and only if the argument is not null and is a Cube object that specifies the same project cube as this object.

Parameters:
object - the object to compare with
Returns:
true if the objects are the same; false otherwise
Overrides:
equals in class Object
o get 
 public static Cube get(Integer id)
Retrieves the project cube for the specified document, if previously put.

Parameters:
id - a document identifier
Returns:
the project cube for this document, if known; otherwise null
o put 
 public void put(Integer id)
Stores this object for later retrieval as the project cube for the specified document.

Parameters:
id - a document identifier
o remove 
 public static Cube remove(Integer id)
Removes the project cube previously put for the specified document, if any.

Parameters:
id - a document identifier
Returns:
the project cube in question, if any; otherwise null
o clear 
 public static void clear()
Removes all project cubes previously put in relationship to documents.

o getAccess 
 public DataRequest getAccess()
Creates a data request to retrieve the access rights defined for this project cube.

Returns:
a data request to retrieve the access rights for a project cube
See Also:
SERVICE
o findFile 
 public DataRequest findFile(String name)
Creates a data request to find and retrieve a document with the specified name with respect to this project cube.

Parameters:
name - the document name
Returns:
a data request to find and retrieve a document for a project cube
See Also:
SERVICE 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

This website has been archived and is no longer maintained.