org.eclipse.emf.emfstore.internal.client.model
Interface Usersession

All Superinterfaces:

APIDelegate<ESUsersessionImpl>, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

UsersessionImpl

public interface Usersession
extends org.eclipse.emf.ecore.EObject, APIDelegate<ESUsersessionImpl>

A representation of the model object ' Usersession'.

See Also:

ModelPackage.getUsersession()

Method Summary

ACUser	getACUser() Returns the value of the 'AC User' containment reference.
org.eclipse.emf.common.util.EList<OrgUnitProperty>	getChangedProperties() Returns the value of the 'Changed Properties' containment reference list.
String	getPassword() Returns the value of the 'Password' attribute.
String	getPersistentPassword() Returns the value of the 'Persistent Password' attribute.
ServerInfo	getServerInfo() Returns the value of the 'Server Info' reference.
SessionId	getSessionId() Returns the value of the 'Session Id' reference.
String	getUsername() Returns the value of the 'Username' attribute.
boolean	isLoggedIn() Check if the user session is currently logged into a server.
boolean	isSavePassword() Returns the value of the 'Save Password' attribute.
void	logIn() Log in.
void	logout() Sends a logout call to the server.
void	setACUser(ACUser value) Sets the value of the 'AC User' containment reference.
void	setPassword(String value) Sets the value of the 'Password' attribute.
void	setPersistentPassword(String value) Sets the value of the 'Persistent Password' attribute.
void	setSavePassword(boolean value) Sets the value of the 'Save Password' attribute.
void	setServerInfo(ServerInfo value) Sets the value of the 'Server Info' reference.
void	setSessionId(SessionId value) Sets the value of the 'Session Id' reference.
void	setUsername(String value) Sets the value of the 'Username' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.emf.emfstore.internal.common.api.APIDelegate

createAPI, toAPI

Method Detail

getUsername

String getUsername()

Returns the value of the 'Username' attribute.

If the meaning of the 'Username' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Username' attribute.

See Also:

setUsername(String), ModelPackage.getUsersession_Username()

setUsername

void setUsername(String value)

Sets the value of the 'Username' attribute.

Parameters:

value - the new value of the 'Username' attribute.

See Also:

getUsername()

getPassword

String getPassword()

Returns the value of the 'Password' attribute.

If the meaning of the 'Password' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Password' attribute.

See Also:

setPassword(String), ModelPackage.getUsersession_Password()

setPassword

void setPassword(String value)

Sets the value of the 'Password' attribute.

Parameters:

value - the new value of the 'Password' attribute.

See Also:

getPassword()

getSessionId

SessionId getSessionId()

Returns the value of the 'Session Id' reference.

If the meaning of the 'Session Id' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Session Id' reference.

See Also:

setSessionId(SessionId), ModelPackage.getUsersession_SessionId()

setSessionId

void setSessionId(SessionId value)

Sets the value of the 'Session Id' reference.

Parameters:

value - the new value of the 'Session Id' reference.

See Also:

getSessionId()

getPersistentPassword

String getPersistentPassword()

Returns the value of the 'Persistent Password' attribute.

If the meaning of the 'Persistent Password' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Persistent Password' attribute.

See Also:

setPersistentPassword(String), ModelPackage.getUsersession_PersistentPassword()

setPersistentPassword

void setPersistentPassword(String value)

Sets the value of the 'Persistent Password' attribute.

Parameters:

value - the new value of the 'Persistent Password' attribute.

See Also:

getPersistentPassword()

getServerInfo

ServerInfo getServerInfo()

Returns the value of the 'Server Info' reference.

If the meaning of the 'Server Info' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Server Info' reference.

See Also:

setServerInfo(ServerInfo), ModelPackage.getUsersession_ServerInfo()

setServerInfo

void setServerInfo(ServerInfo value)

Sets the value of the 'Server Info' reference.

Parameters:

value - the new value of the 'Server Info' reference.

See Also:

getServerInfo()

isSavePassword

boolean isSavePassword()

Returns the value of the 'Save Password' attribute.

If the meaning of the 'Save Password' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Save Password' attribute.

See Also:

setSavePassword(boolean), ModelPackage.getUsersession_SavePassword()

setSavePassword

void setSavePassword(boolean value)

Sets the value of the 'Save Password' attribute.

Parameters:

value - the new value of the 'Save Password' attribute.

See Also:

isSavePassword()

getACUser

ACUser getACUser()

Returns the value of the 'AC User' containment reference.

If the meaning of the 'AC User' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'AC User' containment reference.

See Also:

setACUser(ACUser), ModelPackage.getUsersession_ACUser()

setACUser

void setACUser(ACUser value)

Sets the value of the 'AC User' containment reference.

Parameters:

value - the new value of the 'AC User' containment reference.

See Also:

getACUser()

getChangedProperties

org.eclipse.emf.common.util.EList<OrgUnitProperty> getChangedProperties()

Returns the value of the 'Changed Properties' containment reference list. The list contents are of type OrgUnitProperty.

If the meaning of the 'Changed Properties' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Changed Properties' containment reference list.

See Also:

ModelPackage.getUsersession_ChangedProperties()

logIn

void logIn()
           throws AccessControlException,
                  ESException

Log in.

Throws:

AccessControlException - if login fails.

ESException - if anything else fails.

isLoggedIn

boolean isLoggedIn()

Check if the user session is currently logged into a server.

Returns:

true if it is.

logout

void logout()
            throws ESException

Sends a logout call to the server.

Throws:

ESException - forwards any exception.