com.uc4.api.objects

Class Login

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.Login

All Implemented Interfaces:

java.lang.Iterable<LoginDefinition>

public class Login
extends UC4Object
implements java.lang.Iterable<LoginDefinition>

Login object.

Constructor Summary

Constructors

Constructor and Description
Login()

Method Summary

Modifier and Type	Method and Description
void	addLoginDefinition(LoginDefinition definition) Adds a login definition.
Header	header() Returns the header data of this object.
boolean	isExecutable() Returns true if this Object can be executed.
java.util.Iterator<LoginDefinition>	iterator() Returns an iterator over LoginDefinition.
protected void	loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes info)
boolean	removeLoginDefinition(LoginDefinition definition) Removes the specified login definition from this Login object.
int	size() Returns the number of entries in this Login object.
protected void	storeContent(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo) Stores the object specific data under the objectElement element.

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getType, isOldVersion, load, store, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Login

public Login()

Method Detail

loadContent

protected void loadContent(com.uc4.util.XMLDocument doc,
                           ConnectionAttributes info)

header

public Header header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

iterator

public java.util.Iterator<LoginDefinition> iterator()

Returns an iterator over LoginDefinition.

Specified by:

iterator in interface java.lang.Iterable<LoginDefinition>

Returns:

Iterator over login definitions

addLoginDefinition

public void addLoginDefinition(LoginDefinition definition)

Adds a login definition.

Parameters:

definition - Login definition

removeLoginDefinition

public boolean removeLoginDefinition(LoginDefinition definition)

Removes the specified login definition from this Login object.

Parameters:

definition - Login definition

Returns:

True if the definitiond was removed successfully

size

public int size()

Returns the number of entries in this Login object.

Returns:

Number of login defintions

storeContent

protected void storeContent(com.uc4.util.XMLDocument doc,
                            org.w3c.dom.Element objectElement,
                            ConnectionAttributes sessionInfo)

Description copied from class: UC4Object

Stores the object specific data under the objectElement element.

Parameters:

doc - XML Document, used to create subelements

objectElement - the newly created elements are children of the objectElement element

sessionInfo - Information about the current session

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.