com.wewebu.ow.server.dmsdialogs.views
Class OwObjectHistoryView

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwView
          extended by com.wewebu.ow.server.ui.OwLayout
              extended by com.wewebu.ow.server.dmsdialogs.views.OwObjectHistoryView
All Implemented Interfaces:
OwBaseView, OwUpdateTarget

public class OwObjectHistoryView
extends OwLayout

Display the history of an object.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com


Nested Class Summary
 
Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout
OwLayout.OwDispatchRegion
 
Field Summary
protected  OwObjectCollection m_historyEntries
          the history entries
protected  int m_iMaxSize
          max number of history entries to be retrieved
protected  int m_iViewMask
          filters the views to be displayed
protected  OwObject m_object
          object to find the parents of
protected  OwObjectListView m_ObjectListView
          objectlist that displays the history entries
protected  Collection m_propertyColumnList
          List with property names as columninfos if no searchTemplate_p is provided
protected  OwSearchCriteriaView m_SearchCriteriaView
          displays the filter criteria
protected  OwSearchTemplate m_searchtemplate
          the searchtemplate to be used for filtering history entries
static int MENU_REGION
          region identifier for the layout
static int OBJECT_LIST_REGION
          region identifier for the layout
static int SEARCH_CRITERIA_REGION
          region identifier for the layout
static int VIEW_MASK_HISTORY_SCOPE_CASE
          mask value for the history view, enable case (bpm) history
static int VIEW_MASK_HISTORY_SCOPE_OBJECT
          mask value for the history view, enable object history
 
Fields inherited from class com.wewebu.ow.server.ui.OwLayout
m_Regions
 
Fields inherited from class com.wewebu.ow.server.ui.OwView
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
 
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView
EMPTY_STRING
 
Constructor Summary
OwObjectHistoryView(OwSearchTemplate searchTemplate_p, Collection columnInfoList_p, int iMaxSize_p)
          constructs a history view to display the history of an object
 
Method Summary
protected  Collection createColumnInfo(Collection propertyList_p)
          create a list of OwFieldColumnInfo out of a property string list
 String getFormName()
          get the form used for the edit fields
protected  boolean hasViewMask(int iViewMask_p)
          check if view should be displayed or is masked out
protected  void init()
          init the view after the context is set
protected  void onActivate(int iIndex_p, Object oReason_p)
          activate the target from a navigation module.
protected  void onRender(Writer w_p)
          called when the view should create its HTML content to be displayed
 void onSubmitSearch(javax.servlet.http.HttpServletRequest request_p, Object user_p)
          called when user clicked submit search
 void setObjectRef(OwObject obj_p)
          set the object to find the filed records for
 void setViewMask(int iViewMask_p)
          determine the views to be displayed by masking them with their flag
 
Methods inherited from class com.wewebu.ow.server.ui.OwLayout
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion, renderRegion
 
Methods inherited from class com.wewebu.ow.server.ui.OwView
activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OBJECT_LIST_REGION

public static final int OBJECT_LIST_REGION
region identifier for the layout

See Also:
Constant Field Values

SEARCH_CRITERIA_REGION

public static final int SEARCH_CRITERIA_REGION
region identifier for the layout

See Also:
Constant Field Values

MENU_REGION

public static final int MENU_REGION
region identifier for the layout

See Also:
Constant Field Values

VIEW_MASK_HISTORY_SCOPE_OBJECT

public static final int VIEW_MASK_HISTORY_SCOPE_OBJECT
mask value for the history view, enable object history

See Also:
Constant Field Values

VIEW_MASK_HISTORY_SCOPE_CASE

public static final int VIEW_MASK_HISTORY_SCOPE_CASE
mask value for the history view, enable case (bpm) history

See Also:
Constant Field Values

m_iViewMask

protected int m_iViewMask
filters the views to be displayed


m_object

protected OwObject m_object
object to find the parents of


m_ObjectListView

protected OwObjectListView m_ObjectListView
objectlist that displays the history entries


m_SearchCriteriaView

protected OwSearchCriteriaView m_SearchCriteriaView
displays the filter criteria


m_historyEntries

protected OwObjectCollection m_historyEntries
the history entries


m_searchtemplate

protected OwSearchTemplate m_searchtemplate
the searchtemplate to be used for filtering history entries


m_iMaxSize

protected int m_iMaxSize
max number of history entries to be retrieved


m_propertyColumnList

protected Collection m_propertyColumnList
List with property names as columninfos if no searchTemplate_p is provided

Constructor Detail

OwObjectHistoryView

public OwObjectHistoryView(OwSearchTemplate searchTemplate_p,
                           Collection columnInfoList_p,
                           int iMaxSize_p)
                    throws Exception
constructs a history view to display the history of an object

Parameters:
searchTemplate_p - OwSearchTemplate to use to filter and display the history events, or null if no search is available
columnInfoList_p - List with property names as columninfos if no searchTemplate_p is provided
iMaxSize_p - int max number of history entries to be retrieved
Throws:
Exception
Method Detail

setViewMask

public void setViewMask(int iViewMask_p)
determine the views to be displayed by masking them with their flag

Parameters:
iViewMask_p - bitmask according to VIEW_MASK_SYSTEM_... flags

hasViewMask

protected boolean hasViewMask(int iViewMask_p)
check if view should be displayed or is masked out

Parameters:
iViewMask_p - bitmask according to VIEW_MASK_SYSTEM_... flags

createColumnInfo

protected Collection createColumnInfo(Collection propertyList_p)
                               throws Exception
create a list of OwFieldColumnInfo out of a property string list

Throws:
Exception

init

protected void init()
             throws Exception
init the view after the context is set

Overrides:
init in class OwView
Throws:
Exception

onSubmitSearch

public void onSubmitSearch(javax.servlet.http.HttpServletRequest request_p,
                           Object user_p)
                    throws Exception
called when user clicked submit search

Throws:
Exception

getFormName

public String getFormName()
get the form used for the edit fields

Overrides:
getFormName in class OwView
Returns:
String form name

setObjectRef

public void setObjectRef(OwObject obj_p)
                  throws Exception
set the object to find the filed records for

Parameters:
obj_p - OwObject
Throws:
Exception

onActivate

protected void onActivate(int iIndex_p,
                          Object oReason_p)
                   throws Exception
activate the target from a navigation module. Called when menu item was pressed for this target.

Overrides:
onActivate in class OwView
Parameters:
iIndex_p - int tab index of Navigation
oReason_p - User Object which was submitted when target was attached to the navigation module
Throws:
Exception

onRender

protected void onRender(Writer w_p)
                 throws Exception
called when the view should create its HTML content to be displayed

Overrides:
onRender in class OwView
Parameters:
w_p - Writer object to write HTML to
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.