nesstar.api
Class Bookmark

java.lang.Object
  extended by nesstar.api.Bookmark
All Implemented Interfaces:
Serializable

public class Bookmark
extends Object
implements Serializable

A description in both human and machine understandable form of an operation.
It's expressed as a combination of an URL and a short (normally one line) description.
An operation expressed as a Bookmark can be executed by using an Executor.

See Also:
Serialized Form
Created:
26 April 2002

Constructor Summary
Bookmark(URL url)
          If no description is provided it will be made equal to the URL string representation
Bookmark(URL url, String description)
           
 
Method Summary
 MIMEObject execute()
          The quickest way of executing a Bookmark
 MIMEObject execute(BasicExecutorLog log)
          The quickest way of executing a Bookmark
 String getDescription()
          Gets the description attribute of the Bookmark object
 URL getURL()
          Gets the uRL attribute of the Bookmark object
 void setDescription(char[] description)
          Sets the description attribute of the Bookmark object
 void setDescription(String description)
          Modify the description
 void setURL(URL url)
           
 String toHTMLLink()
          Method
 String toHTMLLink(String description)
          Execute the operation represented by this Bookmark.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Bookmark

public Bookmark(URL url,
                String description)
Parameters:
url - the URL
description - A one line description

Bookmark

public Bookmark(URL url)
If no description is provided it will be made equal to the URL string representation

Parameters:
url - the URL
Method Detail

setDescription

public void setDescription(String description)
Modify the description

Parameters:
description - the new description

setDescription

public void setDescription(char[] description)
Sets the description attribute of the Bookmark object

Parameters:
description - The new description value

getURL

public URL getURL()
Gets the uRL attribute of the Bookmark object

Returns:
The uRL value

setURL

public void setURL(URL url)

getDescription

public String getDescription()
Gets the description attribute of the Bookmark object

Returns:
The description value

toString

public String toString()
Overrides:
toString in class Object
Returns:
a textual representation of the bookmark

toHTMLLink

public String toHTMLLink(String description)
Execute the operation represented by this Bookmark. The output of the operation will be forwarded to the defined Handlers. This method returns immediatly as the command is executed on a separate Thread

Parameters:
description -
Returns:

toHTMLLink

public String toHTMLLink()
Method

Returns:

execute

public MIMEObject execute()
                   throws Exception
The quickest way of executing a Bookmark

Returns:
the result of the operation
Throws:
Exception

execute

public MIMEObject execute(BasicExecutorLog log)
                   throws Exception
The quickest way of executing a Bookmark

Parameters:
log -
Returns:
the result of the operation
Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved