All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Link 

java.lang.Object
   |
   +----icc.db.Link
public final class Link
extends Object
implements Serializable
The Link class represents a one-directional link between two documents. All links originating from the same document are collected as a part of the information available on this document. As such, a link is defined by the other document's identifier, a name, a creation author and date and an optional qualifier string.

Links retrieved from the project database are trusted. Trusted link objects cannot be altered. Instead, create a new (untrusted) copy of this object. Such changes must be submitted to the project database before these become effective.

See Also:
File, alter

Constructor Index

o Link(Integer, String)
Allocates a Link object with the specified document identifier and link name.
o Link(Integer, String, String)
Allocates a Link object with the specified document identifier, link name and qualifier.

Method Index

o dateString()
Returns the creation date and time for this link as a string.
o duplicate()
Duplicates this link.
o getAuthor()
Returns the creation author identifier for this link.
o getDocument()
Returns the document identifier of this link.
o getName()
Returns the link name.
o getQualifier()
Returns the link qualifier.
o getTime()
Returns the creation date and time for this link, in milliseconds since January 1, 1970, 00:00:00.
o isTrusted()
Checks if this is a trusted link.
o setName(String)
Sets the link name.
o setQualifier(String)
Sets the link qualifier.

Constructors

o Link 
 public Link(Integer document,
             String name,
             String qualifier)
Allocates a Link object with the specified document identifier, link name and qualifier.

Parameters:
document - a document identifier
name - a link name
qualifier - a qualifier string
Throws: IllegalArgumentException
Occurs when the document identifier is null, negative or zero, or when the link name is null or an empty string
o Link 
 public Link(Integer document,
             String name)
Allocates a Link object with the specified document identifier and link name.

Parameters:
document - a document identifier
name - a link name
Throws: IllegalArgumentException
Occurs when the document identifier is null, negative or zero, or when the link name is null or an empty string

Methods

o getDocument 
 public Integer getDocument()
Returns the document identifier of this link.

Returns:
a document identifier
o getName 
 public String getName()
Returns the link name.

Returns:
a name
o getQualifier 
 public String getQualifier()
Returns the link qualifier.

Returns:
a string
o getAuthor 
 public Integer getAuthor()
Returns the creation author identifier for this link.

Returns:
a partner identifier
o getTime 
 public long getTime()
Returns the creation date and time for this link, in milliseconds since January 1, 1970, 00:00:00.

Returns:
the number of milliseconds since January 1, 1970, 00:00:00
o dateString 
 public String dateString()
Returns the creation date and time for this link as a string.

Returns:
the creation date string
See Also:
setLocale
o isTrusted 
 public boolean isTrusted()
Checks if this is a trusted link.

Returns:
true if this link is trusted, false otherwise
o duplicate 
 public Link duplicate()
Duplicates this link.

Returns:
a duplicate link
o setName 
 public void setName(String name)
Sets the link name. This link cannot be trusted. Altering link information has no actual effect until this information is updated in the database.

Parameters:
name - a link name
Throws: IllegalArgumentException
Occurs when the link name is null or an empty string
o setQualifier 
 public void setQualifier(String qualifier)
Sets the link qualifier. This link cannot be trusted. Altering link information has no actual effect until this information is updated in the database.

Parameters:
qualifier - a link qualifier 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

This website has been archived and is no longer maintained.