All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Header

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

public class Header

extends Entity

The type of a document is one of TEXT, PATH, URL and PURSE, corresponding to a short text (at most 120 characters) stored entirely in the database, a document available as a file in the file system underlying the database, a document accessible through the HTTP protocol, and an electronic purse, respectively.

The document name reflects on the document type. If the document is of type TEXT, the name specifies this text. If the document is of type PATH, the name specifies the full file path. If the document is of type URL, the name specifies the HTTP address of the document file. Finally, if the document is of type PURSE, the name specifies the remaining value of the electronic purse.

Grouping information is specified as a single belongs link and an array of contains links. Similarly, threading information is specified as a single replyTo link and an array of followUp links. Versioning information is specified as a single previousV link and an array of nextV links.

A document may have a cost associated with it (as an attribute). In this case, the document file cannot be retrieved unless the user has a personal purse document from which the cost is paid.

See Also:

File

belongs

This variable specifies the document this document belongs to, if any.

contains

This variable specifies all the documents this document contains.

ENTRY

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

followUp

This variable specifies all the documents that follow up (comment) on this document.

LENGTH

The maximum length of the name and title of this document.

nextV

This variable specifies all the immediately derived versions of this document.

PATH

A useful constant to specify the type of a document as a file located in the file system underlying the login server.

previousV

This variable specifies the previous version of this document, if any.

PURSE

A useful constant to specify the type of a document as an electronic purse.

QUERY

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

replyTo

This variable specifies the document this document replies to (comments on), if any.

reset

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

SEARCH

The name of a service that searches and retrieves document information from the database on request.

TEXT

A useful constant to specify the type of a document as a short text (at most LENGTH characters) stored entirely in the database.

TYPES

The document types array.

URL

A useful constant to specify the type of a document as a URL.

clear()

Removes all Header objects previously put.

containsHeader(Integer)

Tests if a document header with the specified identifier has previously been put.

description()

Returns the document title.

equals(Object)

Compares this object to the specified object.

getHeader(Integer)

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

getTitle()

Returns the document title.

getType()

Returns the document type.

hasPath()

Returns whether this document specifies a file located in the file system underlying the login server.

hasText()

Returns whether this document specifies a short text (at most LENGTH characters) stored entirely in the database.

hasURL()

Returns whether this document specifies a URL.

isLinked()

Checks if this document is linked to other documents through grouping, threading or versioning.

isPurse()

Returns whether this document specifies a purse.

put()

Stores this object for later retrieval by identifier.

remove()

Removes this object from local storage, if previously put.

removeHeader(Integer)

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

setId(Integer)

Sets the document identifier.

setName(String)

Sets the document name.

setTitle(String)

Sets the document title.

setType(String)

Sets the document type.

 public static final int LENGTH

The maximum length of the name and title of this document.

 public static final String TEXT

A useful constant to specify the type of a document as a short text (at most LENGTH characters) stored entirely in the database.

 public static final String PATH

A useful constant to specify the type of a document as a file located in the file system underlying the login server.

 public static final String URL

A useful constant to specify the type of a document as a URL.

 public static final String PURSE

A useful constant to specify the type of a document as an electronic purse.

 public static final String TYPES[]

The document types array.

 public static final String QUERY

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

 public static final String ENTRY

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

 public static final String SEARCH

The name of a service that searches and retrieves document information from the database on request.

 public static final Request reset

A request to reset all document 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.

 public Integer belongs

This variable specifies the document this document belongs to, if any.

 public Integer replyTo

This variable specifies the document this document replies to (comments on), if any.

 public Integer previousV

This variable specifies the previous version of this document, if any.

 public Integer contains[]

This variable specifies all the documents this document contains.

 public Integer followUp[]

This variable specifies all the documents that follow up (comment) on this document.

 public Integer nextV[]

This variable specifies all the immediately derived versions of this document.

 public boolean hasText()

Returns whether this document specifies a short text (at most LENGTH characters) stored entirely in the database.

Returns:

true if this document is of type TEXT, false otherwise

 public boolean hasPath()

Returns whether this document specifies a file located in the file system underlying the login server.

Returns:

true if this document is of type PATH false otherwise

 public boolean hasURL()

Returns whether this document specifies a URL.

Returns:

true if this document is of type URL false otherwise

 public boolean isPurse()

Returns whether this document specifies a purse.

Returns:

true if this document is of type PURSE false otherwise

 public String getType()

Returns the document type.

Returns:

the document type

 public String getTitle()

Returns the document title.

Returns:

the document title

 public String description()

Returns the document title.

Returns:

the document title

Overrides:

description in class Entity

 public void setName(String name)

Sets the document name. This document may not be trusted. Altering the document information has no actual effect until these changes have been submitted to the project database.

Parameters:

name - the new document name

Overrides:

setName in class Entity

See Also:

create, alter

 public void setId(Integer id)

Sets the document identifier. This document may not be trusted.

Parameters:

id - a document identifier

Overrides:

setId in class Entity

 public void setTitle(String title)

Sets the document title. This document may not be trusted. Altering the document information has no actual effect until these changes have been submitted to the project database.

Parameters:

title - the new document title

See Also:

create, alter

 public void setType(String type)

Sets the document type. This document may not be trusted. Altering the document information has no actual effect until these changes have been submitted to the project database.

Parameters:

type - the new document type

See Also:

create, alter

 public boolean isLinked()

Checks if this document is linked to other documents through grouping, threading or versioning.

Returns:

true if the document is linked, false otherwise

 public boolean equals(Object obj)

Compares this object to the specified object. The result is true if and only if the argument is not null and is an object of the same class that has the same identifier (or either identifier equals to NEW), title, and grouping, threading and versioning links as this object.

Parameters:

obj - the object to compare with

Returns:

true if the objects are the same; false otherwise

Overrides:

equals in class Entity

 public static boolean containsHeader(Integer id)

Tests if a document header with the specified identifier has previously been put.

Parameters:

id - a document identifier

Returns:

true if this document header has previously been put; false otherwise

 public static Header getHeader(Integer id)

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

Parameters:

id - a document identifier

Returns:

the document header corresponding this identifier, if known; otherwise null

 public void put()

Stores this object for later retrieval by identifier. Only trusted objects can be stored.

 public void remove()

Removes this object from local storage, if previously put.

 public static Header removeHeader(Integer id)

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

Parameters:

id - a document identifier

Returns:

the object in question, if any; otherwise null

 public static void clear()

Removes all Header objects previously put.

All Packages  Class Hierarchy  This Package  Previous  Next  Index