com.hlcl.rql.as
Class User

java.lang.Object
  com.hlcl.rql.as.User

All Implemented Interfaces:

CmsClientContainer

public class User
extends java.lang.Object
implements CmsClientContainer

Diese Klasse beschreibt einen User des Projektes.

Author:

LEJAFR

Field Summary

static int	LICENSE_ADMINISTRATOR
static int	LICENSE_AUTHOR
static int	LICENSE_EDITOR
static int	LICENSE_SITE_BUILDER
static int	LICENSE_VISITOR

Constructor Summary

User(CmsClient cmsClient, java.lang.String userGuid)
User constructor comment.

User(CmsClient cmsClient, java.lang.String userGuid, java.lang.String ownLogonGuid)
User constructor comment.

User(CmsClient cmsClient, java.lang.String name, java.lang.String userGuid, java.lang.String userId, java.lang.String fullname, java.lang.String emailAddress)
User constructor comment.

User(CmsClient cmsClient, java.lang.String name, java.lang.String userGuid, java.lang.String userId, java.lang.String fullname, java.lang.String emailAddress, java.lang.String ownLoginGuid)
User constructor comment.

Method Summary

RQLNode	callCms(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck.
java.lang.String	callCmsWithoutParsing(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck.
boolean	cancelPagesSavedAsDraft(Project project) Hebt für alle Seiten dieses Benutzers im Status Entwurf diesen Status auf.
boolean	equals(java.lang.Object obj) Treat users the equals if they have the same name (act as ID).
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getDescription() Liefert die Beschreibung dieses Benutzers zurück.
java.lang.String	getEmailAddress() Liefert die e-Mail Adresse des Users zurück.
java.lang.String	getFullname() Liefert den Langnamen dieses Users zurück, z.B Frank Leja.
java.lang.String	getLdapCity()
java.lang.String	getLdapCountry()
java.lang.String	getLdapDepartment()
Locale	getLocale() Liefert die Locale dieses Benutzers zurück.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID des users unter dem das script läuft.
PageArrayList	getMyPagesInWorkflow(Project project) Liefert alle Seiten dieses Benutzers die noch auf Freigabe warten.
java.lang.String	getName() Liefert den Benutzernamen zurück, z.B.
java.lang.String	getOwnLogonGuid() Liefert die login guid dieses Benutzers, falls er angemeldet ist.
PageArrayList	getPagesSavedAsDraft(Project project) Liefert alle Seiten dieses Benutzers im Status Entwurf.
PageArrayList	getPagesWaitingForCorrection(Project project) Liefert alle Seiten dieses Benutzers, die er zu korrigieren hat.
PageArrayList	getPagesWaitingForRelease(Project project) Liefert alle Seiten, die von diesem Benutzer zu prüfen sind.
java.util.List	getProjects() Liefert eine Liste aller für diesen User zugelassenen Projekte.
java.util.List<ProjectVariant>	getPublishableProjectVariants() Liefert genau die Projektvarianten zurück, die der angemeldete Benutzer auch publizieren kann.
java.util.List<UserGroup>	getUserGroupsInCurrentProject(java.lang.String groupPrefix) Liefert alle Benutzergruppen passend zum gegebenen Prefix, denen dieser Benutzer im aktuellen Projekt zugeordnet ist.
java.lang.String	getUserGuid() Liefert
java.lang.String	getUserId() Liefert die interne ID dieses Benutzers zurück.
UserInterfaceLanguage	getUserInterfaceLanguage() Liefert die Oberflächensprache dieses Benutzers zurück.
int	hashCode() Liefert den HashCode dieses Users.
boolean	hasMoreRightsAsAnAuthor(Project project) Liefert true genau dann, wenn dieser User Editor, Site Builder oder Administrator im gegebenen Projekt ist.
boolean	hasMoreRightsAsAnAuthorInCurrentProject() Liefert true genau dann, wenn dieser User Editor, Site Builder oder Administrator im aktuellen Projekt ist.
boolean	isActive() Liefert true, wenn dieser Benutzer gerade am CMS angemeldet ist.
boolean	isAdministrator(Project project) Liefert true genau dann, wenn dieser User Administrator im gegebenen Projekt ist.
boolean	isAdministratorInCurrentProject() Liefert true genau dann, wenn dieser User Administrator im aktuellen Projekt ist.
boolean	isAuthor(Project project) Liefert true genau dann, wenn dieser User Author im gegebenen Projekt ist.
boolean	isAuthorInCurrentProject() Liefert true genau dann, wenn dieser User Author im aktuellen Projekt ist.
boolean	isDirectEditCtlAndMouse() Liefert true, falls dieser User den DirectEdit mode in seinen Benutzereinstellungen auf CTL und Maus gesetzt hat.
boolean	isDirectEditMouseOnly() Liefert true, falls dieser User den DirectEdit mode in seinen Benutzereinstellungen auf Maus gesetzt hat.
boolean	isSiteBuilder(Project project) Liefert true genau dann, wenn dieser User Site Builder im gegebenen Projekt ist.
boolean	isSiteBuilderInCurrentProject() Liefert true genau dann, wenn dieser User Site Builder im aktuellen Projekt ist.
boolean	isVisitor(Project project) Liefert true genau dann, wenn dieser User Visitor im gegebenen Projekt ist.
boolean	isVisitorInCurrentProject() Liefert true genau dann, wenn dieser User Visitor im aktuellen Projekt ist.
void	logout() Meldet diesen Benutzer vom RD CMS ab, falls er angemeldet ist.
void	setDirectEditMode(boolean withCtlAndMouse) Ändert, wie der Direct Edit mode aktiviert wird.
void	setEmailAddress(java.lang.String emailAddress) Ändert die e-mail Adresse dieses Users.
void	setLocale(Locale locale) Ändert die Locale dieses Benutzers.
void	setUserInterfaceLanguage(UserInterfaceLanguage userInterfaceLanguage) Ändert die Oberflächensprache dieses Benutzers.
int	submitPagesSavedAsDraft(Project project) Übergibt alle Seiten dieses Benutzers im Status Entwurf zur Prüfung an den Workflow (confirm).
java.lang.String	toString() Überschreiben zum Debuggen.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

LICENSE_ADMINISTRATOR

public static final int LICENSE_ADMINISTRATOR

See Also:

Constant Field Values

LICENSE_AUTHOR

public static final int LICENSE_AUTHOR

See Also:

Constant Field Values

LICENSE_EDITOR

public static final int LICENSE_EDITOR

See Also:

Constant Field Values

LICENSE_SITE_BUILDER

public static final int LICENSE_SITE_BUILDER

See Also:

Constant Field Values

LICENSE_VISITOR

public static final int LICENSE_VISITOR

See Also:

Constant Field Values

Constructor Detail

User

public User(CmsClient cmsClient,
            java.lang.String userGuid)

User constructor comment.

User

public User(CmsClient cmsClient,
            java.lang.String userGuid,
            java.lang.String ownLogonGuid)

User constructor comment.

User

public User(CmsClient cmsClient,
            java.lang.String name,
            java.lang.String userGuid,
            java.lang.String userId,
            java.lang.String fullname,
            java.lang.String emailAddress)

User constructor comment.

User

public User(CmsClient cmsClient,
            java.lang.String name,
            java.lang.String userGuid,
            java.lang.String userId,
            java.lang.String fullname,
            java.lang.String emailAddress,
            java.lang.String ownLoginGuid)

User constructor comment.

Method Detail

callCms

public RQLNode callCms(java.lang.String rqlRequest)
                throws RQLException

Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck. Erforderlich für die Ermittlung des Werts eines Textelements.

Specified by:

callCms in interface CmsClientContainer

Throws:

RQLException

callCmsWithoutParsing

public java.lang.String callCmsWithoutParsing(java.lang.String rqlRequest)
                                       throws RQLException

Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck. Erforderlich für die Ermittlung des Werts eines Textelements.

Specified by:

callCmsWithoutParsing in interface CmsClientContainer

Throws:

RQLException

cancelPagesSavedAsDraft

public boolean cancelPagesSavedAsDraft(Project project)
                                throws RQLException

Hebt für alle Seiten dieses Benutzers im Status Entwurf diesen Status auf.

Löscht neue Seiten oder macht Änderung rückgängig. Returns true, if at least one page was submitted.

Throws:

RQLException

equals

public boolean equals(java.lang.Object obj)

Treat users the equals if they have the same name (act as ID).

Overrides:

equals in class java.lang.Object

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getPublishableProjectVariants

public java.util.List<ProjectVariant> getPublishableProjectVariants()
                                                             throws RQLException

Liefert genau die Projektvarianten zurück, die der angemeldete Benutzer auch publizieren kann.

Throws:

RQLException

getDescription

public java.lang.String getDescription()
                                throws RQLException

Liefert die Beschreibung dieses Benutzers zurück.

Throws:

RQLException

getEmailAddress

public java.lang.String getEmailAddress()
                                 throws RQLException

Liefert die e-Mail Adresse des Users zurück.

Returns:

java.lang.String

Throws:

RQLException

getFullname

public java.lang.String getFullname()
                             throws RQLException

Liefert den Langnamen dieses Users zurück, z.B Frank Leja.

Returns:

java.lang.String

Throws:

RQLException

getLdapCity

public java.lang.String getLdapCity()
                             throws RQLException

Returns:

Returns the city of this user from LDAP.

Throws:

RQLException

getLdapCountry

public java.lang.String getLdapCountry()
                                throws RQLException

Returns:

Returns the country of this user from LDAP.

Throws:

RQLException

getLdapDepartment

public java.lang.String getLdapDepartment()
                                   throws RQLException

Returns:

Returns the department (LDAP attribute departmentnumber) of this user from LDAP (shown in Outlook as Department: as well).

Throws:

RQLException

getLocale

public Locale getLocale()
                 throws RQLException

Liefert die Locale dieses Benutzers zurück.

Throws:

RQLException

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die RedDot logon GUID des users unter dem das script läuft. Dies ist nicht die des Users, falls er angemeldet ist!

Specified by:

getLogonGuid in interface CmsClientContainer

See Also:

getOwnLoginGuid

getMyPagesInWorkflow

public PageArrayList getMyPagesInWorkflow(Project project)
                                   throws RQLException

Liefert alle Seiten dieses Benutzers die noch auf Freigabe warten.

Returns:

List of Pages

Throws:

RQLException

getName

public java.lang.String getName()
                         throws RQLException

Liefert den Benutzernamen zurück, z.B. lejefr.

Returns:

java.lang.String

Throws:

RQLException

getOwnLogonGuid

public java.lang.String getOwnLogonGuid()

Liefert die login guid dieses Benutzers, falls er angemeldet ist.

See Also:

getLoginGuid

getPagesSavedAsDraft

public PageArrayList getPagesSavedAsDraft(Project project)
                                   throws RQLException

Liefert alle Seiten dieses Benutzers im Status Entwurf.

Returns:

List of Pages

Throws:

RQLException

getPagesWaitingForCorrection

public PageArrayList getPagesWaitingForCorrection(Project project)
                                           throws RQLException

Liefert alle Seiten dieses Benutzers, die er zu korrigieren hat.

Returns:

List of Pages

Throws:

RQLException

getPagesWaitingForRelease

public PageArrayList getPagesWaitingForRelease(Project project)
                                        throws RQLException

Liefert alle Seiten, die von diesem Benutzer zu prüfen sind.

Returns:

List of Pages

Throws:

RQLException

getProjects

public java.util.List getProjects()
                           throws RQLException

Liefert eine Liste aller für diesen User zugelassenen Projekte.

Throws:

RQLException

getUserGroupsInCurrentProject

public java.util.List<UserGroup> getUserGroupsInCurrentProject(java.lang.String groupPrefix)
                                                        throws RQLException

Liefert alle Benutzergruppen passend zum gegebenen Prefix, denen dieser Benutzer im aktuellen Projekt zugeordnet ist.

Throws:

RQLException

getUserGuid

public java.lang.String getUserGuid()

Liefert

Returns:

java.lang.String

getUserId

public java.lang.String getUserId()
                           throws RQLException

Liefert die interne ID dieses Benutzers zurück.

Returns:

java.lang.String

Throws:

RQLException

getUserInterfaceLanguage

public UserInterfaceLanguage getUserInterfaceLanguage()
                                               throws RQLException

Liefert die Oberflächensprache dieses Benutzers zurück.

Throws:

RQLException

hashCode

public int hashCode()

Liefert den HashCode dieses Users.

Overrides:

hashCode in class java.lang.Object

Returns:

java.lang.String

hasMoreRightsAsAnAuthor

public boolean hasMoreRightsAsAnAuthor(Project project)
                                throws RQLException

Liefert true genau dann, wenn dieser User Editor, Site Builder oder Administrator im gegebenen Projekt ist.

Throws:

RQLException

hasMoreRightsAsAnAuthorInCurrentProject

public boolean hasMoreRightsAsAnAuthorInCurrentProject()
                                                throws RQLException

Liefert true genau dann, wenn dieser User Editor, Site Builder oder Administrator im aktuellen Projekt ist.

Throws:

RQLException

isActive

public boolean isActive()

Liefert true, wenn dieser Benutzer gerade am CMS angemeldet ist.

isAdministrator

public boolean isAdministrator(Project project)
                        throws RQLException

Liefert true genau dann, wenn dieser User Administrator im gegebenen Projekt ist.

Throws:

RQLException

isAdministratorInCurrentProject

public boolean isAdministratorInCurrentProject()
                                        throws RQLException

Liefert true genau dann, wenn dieser User Administrator im aktuellen Projekt ist.

Throws:

RQLException

isAuthor

public boolean isAuthor(Project project)
                 throws RQLException

Liefert true genau dann, wenn dieser User Author im gegebenen Projekt ist.

Throws:

RQLException

isAuthorInCurrentProject

public boolean isAuthorInCurrentProject()
                                 throws RQLException

Liefert true genau dann, wenn dieser User Author im aktuellen Projekt ist.

Throws:

RQLException

isDirectEditCtlAndMouse

public boolean isDirectEditCtlAndMouse()
                                throws RQLException

Liefert true, falls dieser User den DirectEdit mode in seinen Benutzereinstellungen auf CTL und Maus gesetzt hat.

Throws:

RQLException

isDirectEditMouseOnly

public boolean isDirectEditMouseOnly()
                              throws RQLException

Liefert true, falls dieser User den DirectEdit mode in seinen Benutzereinstellungen auf Maus gesetzt hat.

Throws:

RQLException

isSiteBuilder

public boolean isSiteBuilder(Project project)
                      throws RQLException

Liefert true genau dann, wenn dieser User Site Builder im gegebenen Projekt ist.

Throws:

RQLException

isSiteBuilderInCurrentProject

public boolean isSiteBuilderInCurrentProject()
                                      throws RQLException

Liefert true genau dann, wenn dieser User Site Builder im aktuellen Projekt ist.

Throws:

RQLException

isVisitor

public boolean isVisitor(Project project)
                  throws RQLException

Liefert true genau dann, wenn dieser User Visitor im gegebenen Projekt ist.

Throws:

RQLException

isVisitorInCurrentProject

public boolean isVisitorInCurrentProject()
                                  throws RQLException

Liefert true genau dann, wenn dieser User Visitor im aktuellen Projekt ist.

Throws:

RQLException

logout

public void logout()
            throws RQLException

Meldet diesen Benutzer vom RD CMS ab, falls er angemeldet ist.

Throws:

RQLException

setDirectEditMode

public void setDirectEditMode(boolean withCtlAndMouse)
                       throws RQLException

Ändert, wie der Direct Edit mode aktiviert wird. Bei false wird er auf nur Maus gestellt.

Throws:

RQLException

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)
                     throws RQLException

Ändert die e-mail Adresse dieses Users.

Throws:

RQLException

setLocale

public void setLocale(Locale locale)
               throws RQLException

Ändert die Locale dieses Benutzers.

Throws:

RQLException

setUserInterfaceLanguage

public void setUserInterfaceLanguage(UserInterfaceLanguage userInterfaceLanguage)
                              throws RQLException

Ändert die Oberflächensprache dieses Benutzers.

Throws:

RQLException

submitPagesSavedAsDraft

public int submitPagesSavedAsDraft(Project project)
                            throws RQLException

Übergibt alle Seiten dieses Benutzers im Status Entwurf zur Prüfung an den Workflow (confirm). Returns number of submitted pages

Throws:

RQLException

toString

public java.lang.String toString()

Überschreiben zum Debuggen.

Overrides:

toString in class java.lang.Object