de.jakop.lotus.domingo

Interface DViewEntry

All Superinterfaces:

DBase, Serializable

All Known Implementing Classes:

MockViewEntry, ViewEntryHttp, ViewEntryProxy

public interface DViewEntry
extends DBase

Represents a view entry. A view entry describes a row in a view.

Author:

Kurt Riede

Method Summary

Modifier and Type	Method and Description
int	getChildCount() The number of immediate children belonging to the current view entry.
List	getColumnValues() The value of each column in the view entry.
int	getDescendantCount() The number of descendants belonging to the current view entry.
DDocument	getDocument() The document associated with the view entry.
int	getIndentLevel() The indent level of a view entry within the view.
String	getNoteID() The note ID of a view entry of type document.
String	getPosition(char seperator) Returns the position of the entry in the view hierarchy, for example, "2.3" for the third document of the second category.
int	getSibblingCount() Deprecated. use method getSiblingCount() instead
int	getSiblingCount() The number of siblings belonging to the current view entry.
String	getUniversalID()
boolean	isCategory() Indicates whether a view entry is a category.
boolean	isConflict() Indicates if a view entry is for a document on which a replication or save conflict occurred.
boolean	isDocument() Indicates whether a view entry is a document.
boolean	isTotal() Indicates whether a view entry is a total.
boolean	isValid() Indicates whether a view entry is a valid entry and not a deletion stub.

Methods inherited from interface de.jakop.lotus.domingo.DBase

equals, hashCode, toString

Method Detail

getColumnValues

List getColumnValues()

The value of each column in the view entry.

Returns:

list of Double, java.util.Calendar, or String.

getDocument

DDocument getDocument()

The document associated with the view entry.

Returns null if the view entry is not a document. Returns null if the document is deleted after the ViewEntry object is created.

Returns:

the document.

isCategory

boolean isCategory()

Indicates whether a view entry is a category.

Returns:

true if the entry is a category, false if the entry is not a category

isDocument

boolean isDocument()

Indicates whether a view entry is a document.

Returns:

true if the entry is a document, false if the entry is not a document

isTotal

boolean isTotal()

Indicates whether a view entry is a total.

Returns:

true if the entry is a total, false if the entry is not a total

getUniversalID

String getUniversalID()

Returns:

unid.

getChildCount

int getChildCount()

The number of immediate children belonging to the current view entry.

Returns:

number of immediate children belonging to the current view entry

isConflict

boolean isConflict()

Indicates if a view entry is for a document on which a replication or save conflict occurred.

Returns:

true if the entry is a conflict document, false if the entry is not a conflict document

getDescendantCount

int getDescendantCount()

The number of descendants belonging to the current view entry.

Returns:

number of descendants

Since:

domingo 1.1

getSiblingCount

int getSiblingCount()

The number of siblings belonging to the current view entry.

The sibling count includes the current entry unless it is a total.

Returns:

number of siblings

Since:

domingo 1.1

getSibblingCount

int getSibblingCount()

Deprecated. use method getSiblingCount() instead

The number of siblings belonging to the current view entry.

The sibling count includes the current entry unless it is a total.

Returns:

number of siblings

Since:

domingo 1.1

getIndentLevel

int getIndentLevel()

The indent level of a view entry within the view.

The indent level corresponds to the number of levels in the position. Position 1 is indent level 0, position 1.1 is indent level 1, position 1.1.1 is indent level 2, and so on.

Returns:

indent level

Since:

domingo 1.1

isValid

boolean isValid()

Indicates whether a view entry is a valid entry and not a deletion stub.

If a document is removed after a view entry collection containing it is created, you can use the corresponding view entry for navigation but cannot access the document. If the possibility of removal exists, you should check isValid before attempting to access the document.

Returns:

true if a view entry is a valid entry and not a deletion stub

Since:

domingo 1.1

getNoteID

String getNoteID()

The note ID of a view entry of type document.

This property returns the empty string for entries of type category and total.

Returns:

noteID

Since:

domingo 1.1

getPosition

String getPosition(char seperator)

Returns the position of the entry in the view hierarchy, for example, "2.3" for the third document of the second category.

Parameters:

seperator - The separator to be used in the return value.

Returns:

A series of integers (in String format) and separators. The integers indicate the positions of the view entry at each level, where 1 is the first position. The first integer indicates the first level and so on.

Since:

domingo 1.1