com.ibm.notes.java.api.data
Class NotesFramesetData

java.lang.Object
  com.ibm.notes.java.api.data.NotesData
      com.ibm.notes.java.api.data.NotesFramesetData

public class NotesFramesetData
extends NotesData

Class that contains data that would be associated with a Notes frameset.

Field Summary

Fields inherited from class com.ibm.notes.java.api.data.NotesData

baseUrl, ENCODE_ERR, NOTES_COMMAND_SEPARATOR, NOTES_PARAMETER_SEPARATOR, NOTES_PATH_SEPARATOR, NOTES_PROTOCOL, NULL_ERR

Constructor Summary

NotesFramesetData(NotesDatabaseData database, String frameset)
Constructs a NotesFramesetData object from a NotesDatabaseData object and a frameset.

NotesFramesetData(String url)
Constructs a NotesFramesetData object from an encoded Notes URL.

Method Summary

boolean	equals(Object obj) Determines whether two NotesFramesetData objects are equal to each other.
NotesDatabaseData	getDatabaseData()
String	getFramesetUnid() Gets the frameset unid.
String	getName() Gets the frameset name.
String	getOpenUrl() Gets the encoded Notes URL to open the NotesData object.
String	getOpenUrl(NotesViewData viewToOpen) Gets the Notes URL to open this frameset within a specified view.
String	getOpenUrl(String viewUnid) Gets the Notes URL to open this frameset within a specified view.
NotesViewData	getViewData() Constructs a NotesViewData object from this NotesFramesetData object.
protected void	setBaseUrl() Constructs the Notes URL of the data object from the given information.

Methods inherited from class com.ibm.notes.java.api.data.NotesData

encode, getBaseUrl, getParser, removeCommandAndParams

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotesFramesetData

public NotesFramesetData(String url)
                  throws NotesException 

Constructs a NotesFramesetData object from an encoded Notes URL. The URL should be UTF-8 encoded, and not null.

Parameters:

url - the encoded Notes URL

Throws:

NotesException - throw when the NotesFramesetData object cannot be constructed from the URL

Since:

1.5.1

NotesFramesetData

public NotesFramesetData(NotesDatabaseData database,
                         String frameset)
                  throws NotesException 

Constructs a NotesFramesetData object from a NotesDatabaseData object and a frameset. The frameset should not be encoded.

Parameters:

database - the database containing the frameset

frameset - the frameset in the database

Throws:

NotesException - thrown when the NotesFramesetData object could not be constructed from the parameters

Since:

1.5.1

Method Detail

setBaseUrl

protected void setBaseUrl()
                   throws UnsupportedEncodingException

Description copied from class: NotesData

Constructs the Notes URL of the data object from the given information. The URL constructed should only contain the parameters passed in, no commands, or parameters should be added to the URL in this method.

Specified by:

setBaseUrl in class NotesData

Throws:

UnsupportedEncodingException - thrown when the URL cannot be encoded

getName

public String getName()

Gets the frameset name. The returned string will not be encoded. The name may be null. The frameset unid and the frameset name cannot both be null.

Returns:

the frameset name

Since:

1.5.1

getFramesetUnid

public String getFramesetUnid()

Gets the frameset unid. The returned string will not be encoded. The unid may be null. The frameset unid and the frameset name cannot both be null.

Returns:

the frameset unid

Since:

1.5.1

getViewData

public NotesViewData getViewData()
                          throws NotesException 

Constructs a NotesViewData object from this NotesFramesetData object. This will return null if the Notes URL used to construct this object did not contain a view unid parameter.

Returns:

a NotesViewData object based upon the Notes URL passed in to construct

Throws:

NotesException - thrown when we cannot construct the NotesViewData

Since:

1.5.1

equals

public boolean equals(Object obj)

Determines whether two NotesFramesetData objects are equal to each other.

Overrides:

equals in class Object

Parameters:

obj - the object to test for equality

Returns:

true if the two objects are equal, false otherwise

Since:

1.5.1

getOpenUrl

public String getOpenUrl()

Description copied from class: NotesData

Gets the encoded Notes URL to open the NotesData object. The URL is UTF-8 encoded.

Specified by:

getOpenUrl in class NotesData

Returns:

the encoded Notes URL to open the NotesData object

getOpenUrl

public String getOpenUrl(String viewUnid)
                  throws NotesException 

Gets the Notes URL to open this frameset within a specified view. The returned String will be UTF-8 encoded.

Parameters:

viewUNID - view to open the frameset in (has to be an UNID)

Returns:

the Notes URL to open this frameset

Throws:

NotesException - thrown when the viewUnid is not a universal id

Since:

1.5.1

getOpenUrl

public String getOpenUrl(NotesViewData viewToOpen)
                  throws NotesException 

Gets the Notes URL to open this frameset within a specified view. The returned Strng will be UTF-8 encoded.

Parameters:

viewToOpen - the NotesViewData containing information about the view to open the frameset in

Returns:

the Notes URL to open this frameset

Throws:

NotesException - thrown when the viewUnid is not a universal id

Since:

1.5.1

getDatabaseData

public NotesDatabaseData getDatabaseData()