de.bea.domingo.proxy
Class FormProxy

java.lang.Object
  de.bea.domingo.monitor.AbstractMonitorEnabled
      de.bea.domingo.proxy.BaseProxy
          de.bea.domingo.proxy.FormProxy

All Implemented Interfaces:

DBase, DForm, MonitorEnabled, java.io.Serializable

public final class FormProxy
extends BaseProxy
implements DForm

A notes Form.

Author:

Kurt Riede

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseProxy

BaseProxy.DocumentCollectionIterator

Field Summary

Fields inherited from class de.bea.domingo.proxy.BaseProxy

DATETIME_STRING_LENGTH, EMPTY_STRING, MAX_DATETIME_LENGTH, NUM_DATETIME_VALUES, RESOURCES

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.
(package private) static FormProxy	getInstance(NotesProxyFactory theFactory, DDatabase database, lotus.domino.Form form, DNotesMonitor monitor) Returns a form object.
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.
java.lang.String	toString() Returns a short description of an instance.
void	unlock() Unlocks a form.

Methods inherited from class de.bea.domingo.proxy.BaseProxy

checkSession, clearNotesObject, convertCalendarsToNotesDateTime, convertListToVector, convertNotesDateTimesToCalendar, convertVectorToList, createCalendar, createDateRange, createDateTime, decrementDateTimeCounter, finalize, getCountDateTime, getDSession, getFactory, getNotesObject, getParent, incrementDateTimeCounter, newException, newException, newException, newRuntimeException, newRuntimeException, newRuntimeException, recycleDateTimeList, refereceHashCode, toStringGeneric, toStringIntern

Methods inherited from class de.bea.domingo.monitor.AbstractMonitorEnabled

getMonitor, setMonitor

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode

Method Detail

getInstance

static FormProxy getInstance(NotesProxyFactory theFactory,
                             DDatabase database,
                             lotus.domino.Form form,
                             DNotesMonitor monitor)

Returns a form object.

Parameters:

theFactory - the controlling factory

database - Notes database

form - the notes form object

monitor - the monitor

Returns:

a view object

toString

public java.lang.String toString()

Returns a short description of an instance.

Specified by:

toString in interface DBase

Overrides:

toString in class java.lang.Object

Returns:

short description of an instance

See Also:

Object.toString()

getAliases

public 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.

Specified by:

getAliases in interface DForm

Returns:

list of aliases

See Also:

DForm.getAliases()

getFieldType

public int getFieldType(java.lang.String fieldName)

Gets the type of a field on the form.

Specified by:

getFieldType in interface DForm

Parameters:

fieldName - field name

Returns:

type of the field

See Also:

DForm.getFieldType(java.lang.String)

getFields

public java.util.List getFields()

Returns the names of all the fields of a form.

Specified by:

getFields in interface DForm

Returns:

list of field names

See Also:

DForm.getFields()

getFormUsers

public java.util.List getFormUsers()

Returns the contents of the $FormUsers field.

Specified by:

getFormUsers in interface DForm

Returns:

list of names

See Also:

DForm.getFormUsers()

getHttpURL

public java.lang.String getHttpURL()

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

Specified by:

getHttpURL in interface DForm

Returns:

Http URL of a form

See Also:

DForm.getHttpURL()

getLockHolders

public java.util.List getLockHolders()

Returns the names of the holders of a lock.

Specified by:

getLockHolders in interface DForm

Returns:

list of name strings

See Also:

DForm.getLockHolders()

getName

public java.lang.String getName()

Return the name of a form.

Specified by:

getName in interface DForm

Returns:

name of the form

See Also:

DForm.getName()

getNotesURL

public 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.

Specified by:

getNotesURL in interface DForm

Returns:

Domino URL of a form

See Also:

DForm.getNotesURL()

getReaders

public java.util.List getReaders()

Returns the contents of the $Readers field.

Specified by:

getReaders in interface DForm

Returns:

list of reader names

See Also:

DForm.getReaders()

getURL

public java.lang.String getURL()

Returns the Domino URL for the form.

Specified by:

getURL in interface DForm

Returns:

URL

See Also:

DForm.getURL()

isProtectReaders

public boolean isProtectReaders()

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

Specified by:

isProtectReaders in interface DForm

Returns:

true to protect $Readers, else false

See Also:

DForm.isProtectReaders()

isProtectUsers

public boolean isProtectUsers()

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

Specified by:

isProtectUsers in interface DForm

Returns:

true to protect $FormUsers, else false

See Also:

DForm.isProtectUsers()

isSubForm

public boolean isSubForm()

Indicates whether a form is a subform.

Specified by:

isSubForm in interface DForm

Returns:

true if the form is a subform, else false

See Also:

DForm.isSubForm()

lock

public boolean lock()

Locks a form.

Specified by:

lock in interface DForm

Returns:

true if the lock is placed, else false

See Also:

DForm.lock()

lock

public boolean lock(boolean provisionalok)

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

Specified by:

lock in interface DForm

Parameters:

provisionalok - true to permit the placement of a provisional lock

Returns:

true if the lock is placed, else false

See Also:

DForm.lock(boolean)

lock

public 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.

Specified by:

lock in interface DForm

Parameters:

name - name of the lock holder.

Returns:

true if the lock is placed, else false

See Also:

DForm.lock(java.lang.String)

lock

public 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.

Specified by:

lock in interface DForm

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

See Also:

DForm.lock(java.lang.String, boolean)

lock

public boolean lock(java.util.List names)

Locks a form.

Specified by:

lock in interface DForm

Parameters:

names - list of name strings

Returns:

true if the lock is placed, else false

See Also:

DForm.lock(java.util.List)

lock

public 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.

Specified by:

lock in interface DForm

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

See Also:

DForm.lock(java.util.List, boolean)

lockProvisional

public boolean lockProvisional()

Specified by:

lockProvisional in interface DForm

Returns:

true if the lock is placed, else false

See Also:

DForm.lockProvisional()

lockProvisional

public boolean lockProvisional(java.lang.String name)

Specified by:

lockProvisional in interface DForm

Parameters:

name - name of the lock holder.

Returns:

true if the lock is placed, else false

See Also:

DForm.lockProvisional(java.lang.String)

lockProvisional

public boolean lockProvisional(java.util.List names)

Locks a form provisionally.

Specified by:

lockProvisional in interface DForm

Parameters:

names - names list of name strings

Returns:

true if the lock is placed, else false

See Also:

DForm.lockProvisional(java.util.List)

remove

public void remove()

Permanently deletes a form from a database.

Specified by:

remove in interface DForm

See Also:

DForm.remove()

setFormUsers

public void setFormUsers(java.util.List users)

Sets the contents of the $FormUsers field.

Specified by:

setFormUsers in interface DForm

Parameters:

users - list of user names

See Also:

DForm.setFormUsers(java.util.List)

setProtectReaders

public void setProtectReaders(boolean flag)

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

Specified by:

setProtectReaders in interface DForm

Parameters:

flag - true to protect $Readers, else false

See Also:

DForm.setProtectReaders(boolean)

setProtectUsers

public void setProtectUsers(boolean flag)

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

Specified by:

setProtectUsers in interface DForm

Parameters:

flag - true to protect $FormUsers, else false

See Also:

DForm.setProtectUsers(boolean)

setReaders

public void setReaders(java.util.List readers)

Sets the contents of the $Readers field.

Specified by:

setReaders in interface DForm

Parameters:

readers - list of reader names

See Also:

DForm.setReaders(java.util.List)

unlock

public void unlock()

Unlocks a form.

Specified by:

unlock in interface DForm

See Also:

DForm.unlock()