de.bea.domingo
Interface DForm

All Superinterfaces:

DBase, java.io.Serializable

All Known Implementing Classes:

FormProxy

public interface DForm
extends DBase

Represents a form in a database.

Author:

Kurt Riede

Method Summary

java.util.List	getAliases() Returns the aliases of a form.
java.util.List	getFields() Returns the names of all the fields of a form.
int	getFieldType(java.lang.String fieldName) Gets the type of a field on the form.
java.util.List	getFormUsers() Returns the contents of the $FormUsers field.
java.lang.String	getHttpURL() Returns the Domino URL of a form when HTTP protocols are in effect.
java.util.List	getLockHolders() Returns the names of the holders of a lock.
java.lang.String	getName() Return the name of a form.
java.lang.String	getNotesURL() Returns the Domino URL of a form when Notes protocols are in effect.
java.util.List	getReaders() Returns the contents of the $Readers field.
java.lang.String	getURL() Returns the Domino URL for the form.
boolean	isProtectReaders() Returns if the $Readers items is protected from being overwritten by replication.
boolean	isProtectUsers() Returns if the $FormUsers items is protected from being overwritten by replication.
boolean	isSubForm() Indicates whether a form is a subform.
boolean	lock() Locks a form.
boolean	lock(boolean provisionalok) Locks a form.
boolean	lock(java.util.List names) Locks a form.
boolean	lock(java.util.List names, boolean provisionalok) Locks a form.
boolean	lock(java.lang.String name) Locks a form.
boolean	lock(java.lang.String name, boolean provisionalok) Locks a form.
boolean	lockProvisional()
boolean	lockProvisional(java.util.List names) Locks a form provisionally.
boolean	lockProvisional(java.lang.String name)
void	remove() Permanently deletes a form from a database.
void	setFormUsers(java.util.List users) Sets the contents of the $FormUsers field.
void	setProtectReaders(boolean flag) Sets if the $Readers items is protected from being overwritten by replication.
void	setProtectUsers(boolean flag) Sets if the $FormUsers items is protected from being overwritten by replication.
void	setReaders(java.util.List readers) Sets the contents of the $Readers field.
void	unlock() Unlocks a form.

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode, toString

Method Detail

getAliases

java.util.List getAliases()

Returns the aliases of a form. This property returns all but the first in the list of all the form's names. The Name property returns the first name in the list.

Returns:

list of aliases

getFields

java.util.List getFields()

Returns the names of all the fields of a form.

Returns:

list of field names

getFormUsers

java.util.List getFormUsers()

Returns the contents of the $FormUsers field.

Returns:

list of names

setFormUsers

void setFormUsers(java.util.List users)

Sets the contents of the $FormUsers field.

Parameters:

users - list of user names

getName

java.lang.String getName()

Return the name of a form.

Returns:

name of the form

getReaders

java.util.List getReaders()

Returns the contents of the $Readers field.

Returns:

list of reader names

setReaders

void setReaders(java.util.List readers)

Sets the contents of the $Readers field.

Parameters:

readers - list of reader names

isSubForm

boolean isSubForm()

Indicates whether a form is a subform.

Returns:

true if the form is a subform, else false

isProtectReaders

boolean isProtectReaders()

Returns if the $Readers items is protected from being overwritten by replication.

Returns:

true to protect $Readers, else false

setProtectReaders

void setProtectReaders(boolean flag)

Sets if the $Readers items is protected from being overwritten by replication.

Parameters:

flag - true to protect $Readers, else false

isProtectUsers

boolean isProtectUsers()

Returns if the $FormUsers items is protected from being overwritten by replication.

Returns:

true to protect $FormUsers, else false

setProtectUsers

void setProtectUsers(boolean flag)

Sets if the $FormUsers items is protected from being overwritten by replication.

Parameters:

flag - true to protect $FormUsers, else false

remove

void remove()

Permanently deletes a form from a database.

getURL

java.lang.String getURL()

Returns the Domino URL for the form.

Returns:

URL

getNotesURL

java.lang.String getNotesURL()

Returns the Domino URL of a form when Notes protocols are in effect. If Notes protocols are not available, this property returns an empty string.

Returns:

Domino URL of a form

Since:

Lotus Notes Release 6.5.

getHttpURL

java.lang.String getHttpURL()

Returns the Domino URL of a form when HTTP protocols are in effect.

Returns:

Http URL of a form

Since:

Lotus Notes Release 6.5.

getFieldType

int getFieldType(java.lang.String fieldName)

Gets the type of a field on the form.

Parameters:

fieldName - field name

Returns:

type of the field

See Also:

DItem.getType()

getLockHolders

java.util.List getLockHolders()

Returns the names of the holders of a lock.

Returns:

list of name strings

Since:

Lotus Notes Release 6.5.

lock

boolean lock()

Locks a form.

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lock

boolean lock(boolean provisionalok)

Locks a form. The lock holder defaults to the effective user.

Parameters:

provisionalok - true to permit the placement of a provisional lock

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lock

boolean lock(java.lang.String name)

Locks a form. The holder must be a user or group. Defaults to the effective user. The empty string ("") is not permitted.

Parameters:

name - name of the lock holder.

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lock

boolean lock(java.lang.String name,
             boolean provisionalok)

Locks a form. The lock holder must be a user or group. Defaults to the effective user. The empty string ("") is not permitted.

Parameters:

name - name of the lock holder.

provisionalok - true to permit the placement of a provisional lock

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lock

boolean lock(java.util.List names)

Locks a form.

Parameters:

names - list of name strings

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lock

boolean lock(java.util.List names,
             boolean provisionalok)

Locks a form. The lock holder must be a user or group. Defaults to one lock holder: the effective user. The empty string ("") is not permitted.

Parameters:

names - names of the lock holders

provisionalok - true to permit the placement of a provisional lock

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lockProvisional

boolean lockProvisional()

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lockProvisional

boolean lockProvisional(java.lang.String name)

Parameters:

name - name of the lock holder.

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5.

lockProvisional

boolean lockProvisional(java.util.List names)

Locks a form provisionally.

Parameters:

names - names list of name strings

Returns:

true if the lock is placed, else false

Since:

Lotus Notes Release 6.5., Lotus Notes Release 6.5.

unlock

void unlock()

Unlocks a form.

Since:

Lotus Notes Release 6.5.