com.hlcl.rql.hip.as
Class ContentPage

java.lang.Object
  extended by com.hlcl.rql.util.as.ProjectPage
      extended by com.hlcl.rql.hip.as.ContentPage

public class ContentPage
extends ProjectPage

Author:
lejafr This class represents a content page in the HIP project.

Constructor Summary
ContentPage(Page page)
          Construct a content page wrapping the given general page.
 
Method Summary
 boolean containsPageUpdated()
          Liefert true, falls diese content page ein page last updated element (im Footer) besitzt.
 Page createBlock(Template blockTemplate, java.lang.String headline)
          Creates a new page on the blocks container.
 Page createBlock(Template blockTemplate, java.lang.String headline, boolean addAtBottom)
          Creates a new page on the blocks container.
 java.lang.String getResponsibleArea()
          Returns the responsible row's area (Corporate, Region Europe).
 java.lang.String getResponsibleBackupRccUserId()
          Returns the responsible row's backup regional content coordinator's user name (lejafr, strutku).
 java.lang.String getResponsibleBackupRccUserName()
          Returns the responsible row's backup regional content coordinator's user name (Frank Leja, Kurt Strutz).
 java.lang.String getResponsibleDepartmentName()
          Returns the responsible row's source department name.
 java.lang.String getResponsibleDepartmentNumber()
          Returns the responsible row's source department number.
 java.lang.String getResponsibleRccUserId()
          Returns the responsible row's regional content coordinator's user id (lejafr, strutku).
 java.lang.String getResponsibleRccUserName()
          Returns the responsible row's regional content coordinator's user name (Frank Leja, Kurt Strutz).
 java.lang.String getResponsibleStatisticArea()
          Returns the responsible row's mail subject statistic area (COM, SAL).
 java.lang.String getResponsibleUserIdIfAvailable(java.lang.String ifNotAvailable)
          Gets the responsible user id if template element available
 java.lang.String getResponsibleUserNameIfAvailable(java.lang.String ifNotAvailable)
          Gets the responsible user name if template element available
 java.lang.String getResponsibleWorkArea()
          Returns the responsible row's mail subject work area (business-administration, trade-management).
 java.lang.String getUpdatedOnIfAvailable(java.lang.String ifNotAvailable)
          Gets the updated date if template element available
 boolean isResponsibleLinked()
          Return true, if this page has a responsible table row linked, otherwise false.
 void linkResponsible(Page responsibleTableRowPg)
          Connect the given responsible table row to this page.
 void setFooter(java.lang.String responsibleId, java.lang.String displayName)
          Sets the responsible information for given domain option list value, page updated to today.
 void setFooter(java.lang.String responsibleId, java.lang.String displayName, ReddotDate updated)
          Sets the responsible information for given domain option list value.
 void setUpdated(java.util.Date timestamp)
          Sets the page updated to given date.
 void setUpdated(ReddotDate date)
          Sets the page updated to given date.
 void setUpdatedIfPageContainsElement(java.util.Date timestamp)
          Sets the page updated to the given date, if wrapped page has element page_updated.
 ReddotDate updatedToday()
          Sets the page updated to today and returns this reddot date.
 
Methods inherited from class com.hlcl.rql.util.as.ProjectPage
assignAuthorizationPackage, contains, createAndConnectPageAtContainer, enterText, getCreatedByUserName, getCreatedOn, getInfoText, getInfoText, getLastChangedByUserEmailAddress, getLastChangedByUserName, getLastChangedOnAsddMMyyyyHmma, getLockedByUserEmailAddress, getLockedByUserName, getLockedSinceAsddMMyyyyHmma, getOptionListValue, getPage, getPageHeadline, getPageHeadlineAndId, getPageId, getPageInfoText, getProject, getStandardFieldDateElement, getStandardFieldDateValue, getStandardFieldNumericElement, getStandardFieldNumericValue, getStandardFieldTextElement, getStandardFieldTextValue, getStateInfo, getTemplateByGuid, getTextElement, getTextValue, isChangeable, isInStateSavedAsDraft, isLocked, isTextEmpty, setElementValues, setFilename, setHeadline, setOptionListValue, setStandardFieldDateValue, setStandardFieldNumericValue, setStandardFieldTextValue, setTextValue, submitToWorkflow
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContentPage

public ContentPage(Page page)
Construct a content page wrapping the given general page.

Method Detail

createBlock

public Page createBlock(Template blockTemplate,
                        java.lang.String headline)
                 throws RQLException
Creates a new page on the blocks container.

Parameters:
blockTemplate - Typ der neu erstellten Seite.
headline - Ueberschrift der neu erstellten Seite
Throws:
RQLException

createBlock

public Page createBlock(Template blockTemplate,
                        java.lang.String headline,
                        boolean addAtBottom)
                 throws RQLException
Creates a new page on the blocks container.

Parameters:
blockTemplate - Typ der neu erstellten Seite.
headline - Ueberschrift der neu erstellten Seite
addAtBottom - true=>seite wird nach unten verschoben, false=>seite wird nicht verschoben und RD default is oben anlegen
Throws:
RQLException

setFooter

public void setFooter(java.lang.String responsibleId,
                      java.lang.String displayName)
               throws RQLException
Sets the responsible information for given domain option list value, page updated to today.

Parameters:
responsibleId - name of the mailbox; part before @
displayName - clickable name of the mail address
Throws:
RQLException

setFooter

public void setFooter(java.lang.String responsibleId,
                      java.lang.String displayName,
                      ReddotDate updated)
               throws RQLException
Sets the responsible information for given domain option list value.

Parameters:
responsibleId - name of the mailbox; part before @
displayName - clickable name of the mail address
updated - the page updated date
Throws:
RQLException

updatedToday

public ReddotDate updatedToday()
                        throws RQLException
Sets the page updated to today and returns this reddot date.

Throws:
RQLException

setUpdated

public void setUpdated(java.util.Date timestamp)
                throws RQLException
Sets the page updated to given date.

Throws:
RQLException

isResponsibleLinked

public boolean isResponsibleLinked()
                            throws RQLException
Return true, if this page has a responsible table row linked, otherwise false.

Throws:
RQLException

getResponsibleArea

public java.lang.String getResponsibleArea()
                                    throws RQLException
Returns the responsible row's area (Corporate, Region Europe). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleDepartmentNumber

public java.lang.String getResponsibleDepartmentNumber()
                                                throws RQLException
Returns the responsible row's source department number. Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleDepartmentName

public java.lang.String getResponsibleDepartmentName()
                                              throws RQLException
Returns the responsible row's source department name. Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleStatisticArea

public java.lang.String getResponsibleStatisticArea()
                                             throws RQLException
Returns the responsible row's mail subject statistic area (COM, SAL). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleWorkArea

public java.lang.String getResponsibleWorkArea()
                                        throws RQLException
Returns the responsible row's mail subject work area (business-administration, trade-management). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleRccUserId

public java.lang.String getResponsibleRccUserId()
                                         throws RQLException
Returns the responsible row's regional content coordinator's user id (lejafr, strutku). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleRccUserName

public java.lang.String getResponsibleRccUserName()
                                           throws RQLException
Returns the responsible row's regional content coordinator's user name (Frank Leja, Kurt Strutz). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleBackupRccUserName

public java.lang.String getResponsibleBackupRccUserName()
                                                 throws RQLException
Returns the responsible row's backup regional content coordinator's user name (Frank Leja, Kurt Strutz). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

getResponsibleBackupRccUserId

public java.lang.String getResponsibleBackupRccUserId()
                                               throws RQLException
Returns the responsible row's backup regional content coordinator's user name (lejafr, strutku). Use only, if isResponsibleLinked() is true.

Throws:
RQLException

linkResponsible

public void linkResponsible(Page responsibleTableRowPg)
                     throws RQLException
Connect the given responsible table row to this page. Removes another linked table row page before, if necessary.

Throws:
WrongTypeException, - if the given page is not an instance of responsible_table_row
RQLException

setUpdated

public void setUpdated(ReddotDate date)
                throws RQLException
Sets the page updated to given date.

Throws:
RQLException

setUpdatedIfPageContainsElement

public void setUpdatedIfPageContainsElement(java.util.Date timestamp)
                                     throws RQLException
Sets the page updated to the given date, if wrapped page has element page_updated. Otherwise do nothing.

Throws:
RQLException

getResponsibleUserNameIfAvailable

public java.lang.String getResponsibleUserNameIfAvailable(java.lang.String ifNotAvailable)
                                                   throws RQLException
Gets the responsible user name if template element available

Parameters:
ifNotAvailable -
Returns:
Throws:
RQLException

getResponsibleUserIdIfAvailable

public java.lang.String getResponsibleUserIdIfAvailable(java.lang.String ifNotAvailable)
                                                 throws RQLException
Gets the responsible user id if template element available

Parameters:
ifNotAvailable -
Returns:
Throws:
RQLException

containsPageUpdated

public boolean containsPageUpdated()
                            throws RQLException
Liefert true, falls diese content page ein page last updated element (im Footer) besitzt.

Throws:
RQLException

getUpdatedOnIfAvailable

public java.lang.String getUpdatedOnIfAvailable(java.lang.String ifNotAvailable)
                                         throws RQLException
Gets the updated date if template element available

Parameters:
ifNotAvailable -
Returns:
Throws:
RQLException