com.hlcl.rql.hip.as
Class WorkflowCheckItem

java.lang.Object
  extended by com.hlcl.rql.hip.as.WorkflowCheckItem
All Implemented Interfaces:
java.lang.Comparable

public class WorkflowCheckItem
extends java.lang.Object
implements java.lang.Comparable

Author:
lejafr This class represents one page to check.
See Also:
WorkflowCheckModel

Constructor Summary
WorkflowCheckItem(WorkflowCheckModel model, Page page)
          Creates an item, wrapping the given page.
 
Method Summary
 WorkflowCheckItem addChild(Page childPage)
          Add given page as new workflow check item child.
 int compareTo(java.lang.Object o)
          Implement to sort by page headline.
 void confirm()
          Confirm the page
 boolean equals(java.lang.Object obj)
          Return true, if the pages are equal.
 java.util.List getChilds()
          Return the childs (a list of workflow check items) or null, if no items exists.
 java.lang.String getCreatedByUserName()
          Return the name of the user who created the page.
 java.lang.String getHeadline()
          Return the headline of the page.
 java.lang.String getHeadlineAndId()
          Return the headline and the ID of the page.
 java.lang.String getId()
          Return the page ID as the ID of this check item too.
 java.lang.String getNoteValue()
          Return the value of the administrative note where the rejection comment is saved.
 java.lang.String getPageGuid()
          Return the page GUID of the page.
 java.lang.String getTemplateName()
          Return the name of the template of the page.
 void reject(java.lang.String comment)
          Reject the page with the given comment.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkflowCheckItem

public WorkflowCheckItem(WorkflowCheckModel model,
                         Page page)
Creates an item, wrapping the given page.

Method Detail

addChild

public WorkflowCheckItem addChild(Page childPage)
                           throws RQLException
Add given page as new workflow check item child.

Throws:
RQLException

compareTo

public int compareTo(java.lang.Object o)
Implement to sort by page headline.

Specified by:
compareTo in interface java.lang.Comparable

confirm

public void confirm()
             throws RQLException
Confirm the page

Throws:
RQLException

equals

public boolean equals(java.lang.Object obj)
Return true, if the pages are equal.

Overrides:
equals in class java.lang.Object

getChilds

public java.util.List getChilds()
Return the childs (a list of workflow check items) or null, if no items exists.


getCreatedByUserName

public java.lang.String getCreatedByUserName()
                                      throws RQLException
Return the name of the user who created the page.

Throws:
RQLException

getHeadline

public java.lang.String getHeadline()
                             throws RQLException
Return the headline of the page.

Throws:
RQLException

getHeadlineAndId

public java.lang.String getHeadlineAndId()
                                  throws RQLException
Return the headline and the ID of the page.

Throws:
RQLException

getId

public java.lang.String getId()
                       throws RQLException
Return the page ID as the ID of this check item too.

Throws:
RQLException

getNoteValue

public java.lang.String getNoteValue()
                              throws RQLException
Return the value of the administrative note where the rejection comment is saved.

Throws:
RQLException

getPageGuid

public java.lang.String getPageGuid()
                             throws RQLException
Return the page GUID of the page.

Throws:
RQLException

getTemplateName

public java.lang.String getTemplateName()
                                 throws RQLException
Return the name of the template of the page.

Throws:
RQLException

reject

public void reject(java.lang.String comment)
            throws RQLException
Reject the page with the given comment.

Throws:
RQLException