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

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwDocument
          extended by com.wewebu.ow.server.dmsdialogs.views.OwObjectLinksDocument
All Implemented Interfaces:
OwAttributeBag, OwAttributeBagWriteable

public class OwObjectLinksDocument
extends OwDocument

Document class of OwObjectLinksView. Defines the links and the splits that will be displayed by the view.

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

Since:
4.1.1.0

Field Summary
 
Fields inherited from class com.wewebu.ow.server.ui.OwDocument
m_ViewList
 
Constructor Summary
OwObjectLinksDocument(OwObjectLinkRelation relation)
          Constructor
OwObjectLinksDocument(OwObjectLinkRelation relation, Collection<String> filterClassNames, List<String> documentFunctionIds)
          Constructor
 
Method Summary
protected  boolean filterOut(OwObjectLink link)
           
 List<String> getColumnNames()
          Will return a list of column names, which should be displayed.
 List<String> getLinkFunctionsIDs()
           
protected  OwObjectCollection getLinks()
           
 OwObject getObject()
           
 OwObjectLinkRelation[] getRelations()
           
 OwObjectCollection[] getSplits()
          (overridable) Returns an array of OwObjectCollection's containing objects for specific relation direction.
By default the array will have the same order like the relation directions array of getRelations().
 void setColumnNames(List<String> columnNames)
          Set a list of column names, or clear a list (provide null).
 void setObject(OwObject object)
           
protected  void updateLinkViews()
           
 
Methods inherited from class com.wewebu.ow.server.ui.OwDocument
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getPersistentAttributeBagWriteable, getSafeAttribute, hasAttribute, init, remove, save, setAttribute, update
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OwObjectLinksDocument

public OwObjectLinksDocument(OwObjectLinkRelation relation)
Constructor

Parameters:
relation - relation used to split the lists by. The OwObjectLinkRelation.NONE is interpreted as any relation.Resulted link splits will be displayed preserving the order in this array.

OwObjectLinksDocument

public OwObjectLinksDocument(OwObjectLinkRelation relation,
                             Collection<String> filterClassNames,
                             List<String> documentFunctionIds)
Constructor

Parameters:
relation - relation used to split the lists by. The OwObjectLinkRelation.NONE is interpreted as any relation.Resulted link splits will be displayed preserving the order in this array.
filterClassNames - link object class name of object links that will be displayed. If null all object links will be displayed regardless of their class.
documentFunctionIds - document function IDs to be associated with the link object list entries
Method Detail

filterOut

protected boolean filterOut(OwObjectLink link)

getObject

public OwObject getObject()

getLinks

protected OwObjectCollection getLinks()
                               throws OwException
Throws:
OwException

getRelations

public OwObjectLinkRelation[] getRelations()

setObject

public void setObject(OwObject object)
               throws OwException
Throws:
OwException

updateLinkViews

protected void updateLinkViews()
                        throws OwException
Throws:
OwException

getLinkFunctionsIDs

public List<String> getLinkFunctionsIDs()

setColumnNames

public void setColumnNames(List<String> columnNames)
Set a list of column names, or clear a list (provide null).

Parameters:
columnNames - List of Strings or null

getColumnNames

public List<String> getColumnNames()
Will return a list of column names, which should be displayed.

Returns:
List of String's, or null if not set

getSplits

public OwObjectCollection[] getSplits()
                               throws OwException
(overridable) Returns an array of OwObjectCollection's containing objects for specific relation direction.
By default the array will have the same order like the relation directions array of getRelations().

Returns:
OwObjectCollection array containing OwObjectLink instances
Throws:
OwException


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.