com.wewebu.ow.server.plug.owaddmultidocuments
Class OwAddMultiDocumentsDocument

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.plug.owaddmultidocuments.OwAddMultiDocumentsDocument
All Implemented Interfaces:
com.wewebu.ow.server.app.OwDocumentImporterCallback, com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner, com.wewebu.ow.server.ecm.OwLocation, com.wewebu.ow.server.util.OwAttributeBag, com.wewebu.ow.server.util.OwAttributeBagWriteable

public class OwAddMultiDocumentsDocument
extends com.wewebu.ow.server.ui.OwDocument
implements com.wewebu.ow.server.app.OwDocumentImporterCallback, com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner, com.wewebu.ow.server.ecm.OwLocation

Main document class for multi file upload, which also hold the skeleton object for meta-data handling and methods for handling of DocumentImporter-Callbacks.

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


Field Summary
protected  com.wewebu.ow.server.ecm.OwObject m_parentFolder
          the parent folder, required for special handling of virtual folders
protected  ArrayList m_propertyInfos
          collection of OwPropertyInfo objects defining read only properties.
protected  com.wewebu.ow.server.ecm.OwResource m_resource
          the resource used to search for document classes
protected  String strUserSelectedClassName
          the object class name which was selected by user action
 
Fields inherited from class com.wewebu.ow.server.ui.OwDocument
m_ViewList
 
Constructor Summary
OwAddMultiDocumentsDocument(com.wewebu.ow.server.ecm.OwResource resource_p, com.wewebu.ow.server.ecm.OwObject parentFolder_p)
          construct a save document with the resource to work on
 
Method Summary
protected  com.wewebu.ow.server.ecm.OwObjectSkeleton createSkeletonObject(com.wewebu.ow.server.ecm.OwObjectClass objectClass_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
          overridable factory method
 String getClassName()
          Get ObjectClass name which should be used for objects by default.
 com.wewebu.ow.server.app.OwDocumentImporter getDocumentImporter(int i_p)
          Returns the importer depending on the imported item, which is given as parameter i_p.
 com.wewebu.ow.server.app.OwDocumentImporter getDocumentImporter(com.wewebu.ow.server.app.OwDocumentImportItem item_p)
          Returns the importer depending on the imported item, which is given as parameter item_p.
 com.wewebu.ow.server.app.OwDocumentImportItem getImportedDocument(int idx_p)
          Return a OwDocumentImportItem of the given index.
 int getImportedDocumentsCount()
          Return the amount of imported document item's
 com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor getObjectClassProcessor()
          Getter of current OwObjectClassProcessor
 com.wewebu.ow.server.ecm.OwObject getParent()
           
 Collection getPropertyInfos()
           
 com.wewebu.ow.server.ecm.OwResource getResource()
          Returns the OwResource where the new objects are created.
 com.wewebu.ow.server.ecm.OwObjectSkeleton getSkeletonObject(boolean fRenew_p)
           
 String getUserSelectedClassName()
          Return a String which represents the ObjectClass name selected by user action.
 boolean hasUndefinedObjectClass()
          If an document was added which OwDocumentImportItem.getObjectClassName() has returned null.
 boolean isValidObjecClass(String objectClass_p)
          Check if the given objectClass name is valid for current context.
 void onDocumentImported(com.wewebu.ow.server.app.OwDocumentImporter importer_p, com.wewebu.ow.server.app.OwDocumentImportItem importedDocument_p)
           
 void onObjectClassViewSelectClass(com.wewebu.ow.server.ecm.OwObjectClass classDescription_p, String strPath_p)
          Refactoring of handler for OwObjectClass selection by user action.
protected  com.wewebu.ow.server.ecm.OwObjectClass preProcessObjectClass(com.wewebu.ow.server.ecm.OwObjectClass objCls_p)
          (overridable) PreCreation skeleton object handling of ObjectClass, delegated to current OwObjectClassProcessor instance.
Will return the OwObjectClass which should be used as skeleton object class.
 void releaseImportedDocument(com.wewebu.ow.server.app.OwDocumentImportItem importedDocument_p)
          This is a clean up method for a cached document item.
 void releaseImportedDocuments()
          This is a clean up method for cached document items.
 void setClassName(String objectClassname_p)
          Set an ObjectClass name as default class.
 void setObjectClass(com.wewebu.ow.server.ecm.OwObjectClass objectClass_p)
          Set the ObjectClass for skeleton objects which are used before creating a real instance of that object.
 void setObjectClassProcessor(com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor processor)
          Setter for OwObjectClassProcessor
protected  void setShowProcessViewFlag(boolean value_p)
          Set the flag for post processing view of documents.
protected  void setUndefinedObjectClassFlag(boolean value_p)
          Set the flag for undefined object class to given value.
protected  void setUserSelectedClassName(String userSelectedObjectClass_p)
          Method to set an ObjectClass name selected by user action.
 boolean showProcessView()
          If an document was added which DocumentImporter has a post processing view, this method will return true.
 
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
 

Field Detail

m_resource

protected com.wewebu.ow.server.ecm.OwResource m_resource
the resource used to search for document classes


m_parentFolder

protected com.wewebu.ow.server.ecm.OwObject m_parentFolder
the parent folder, required for special handling of virtual folders


m_propertyInfos

protected ArrayList m_propertyInfos
collection of OwPropertyInfo objects defining read only properties. Only required if parentFolder is a virtual folder


strUserSelectedClassName

protected String strUserSelectedClassName
the object class name which was selected by user action

Since:
2.5.2.0
Constructor Detail

OwAddMultiDocumentsDocument

public OwAddMultiDocumentsDocument(com.wewebu.ow.server.ecm.OwResource resource_p,
                                   com.wewebu.ow.server.ecm.OwObject parentFolder_p)
construct a save document with the resource to work on

Method Detail

getResource

public com.wewebu.ow.server.ecm.OwResource getResource()
Returns the OwResource where the new objects are created.

Specified by:
getResource in interface com.wewebu.ow.server.ecm.OwLocation
Returns:
the OwResource where the new objects are created.

getPropertyInfos

public Collection getPropertyInfos()

setObjectClass

public void setObjectClass(com.wewebu.ow.server.ecm.OwObjectClass objectClass_p)
                    throws Exception
Set the ObjectClass for skeleton objects which are used before creating a real instance of that object. Also fire an update Event of type OwUpateCodes.SET_NEW_OBJECT.

Parameters:
objectClass_p - OwObjectClass
Throws:
Exception
com.wewebu.ow.server.exceptions.OwInvalidOperationException - if OwNetwork.createObjectSkeleton(OwbjectClass, OwResource} returns null

createSkeletonObject

protected com.wewebu.ow.server.ecm.OwObjectSkeleton createSkeletonObject(com.wewebu.ow.server.ecm.OwObjectClass objectClass_p,
                                                                         com.wewebu.ow.server.app.OwMainAppContext context_p)
                                                                  throws Exception
overridable factory method

Parameters:
objectClass_p -
context_p -
Returns:
OwObjectSkeleton
Throws:
Exception
Since:
3.2.0.0

getSkeletonObject

public com.wewebu.ow.server.ecm.OwObjectSkeleton getSkeletonObject(boolean fRenew_p)
                                                            throws Exception
Parameters:
fRenew_p - a boolean
Returns:
an OwObjectSkeleton
Throws:
Exception

getImportedDocument

public com.wewebu.ow.server.app.OwDocumentImportItem getImportedDocument(int idx_p)
Return a OwDocumentImportItem of the given index.

Can throw IndexOutOfBoundsException if idx_p > getImportedDocumentsCount() or less than 0 (zero)

Parameters:
idx_p - int index of item to be returned
Returns:
OwDocumentImportItem
See Also:
getImportedDocumentsCount()

getImportedDocumentsCount

public int getImportedDocumentsCount()
Return the amount of imported document item's

Returns:
int amount of imported document item's

releaseImportedDocument

public void releaseImportedDocument(com.wewebu.ow.server.app.OwDocumentImportItem importedDocument_p)
                             throws Exception
This is a clean up method for a cached document item. First the given document item is released OwDocumentImportItem.release() and afterwards the caching entry from structure is cleared.

Parameters:
importedDocument_p - OwDocumentImportItem - the document to be released
Throws:
Exception - if release of OwDocumentImportItem creates a failure
Since:
2.5.3.0

releaseImportedDocuments

public void releaseImportedDocuments()
                              throws Exception
This is a clean up method for cached document items. First all document items are released OwDocumentImportItem.release() and afterwards the caching structure is cleared.

Throws:
Exception - if release of OwDocumentImportItem creates a failure

onDocumentImported

public void onDocumentImported(com.wewebu.ow.server.app.OwDocumentImporter importer_p,
                               com.wewebu.ow.server.app.OwDocumentImportItem importedDocument_p)
                        throws Exception
Specified by:
onDocumentImported in interface com.wewebu.ow.server.app.OwDocumentImporterCallback
Throws:
Exception

getDocumentImporter

public com.wewebu.ow.server.app.OwDocumentImporter getDocumentImporter(com.wewebu.ow.server.app.OwDocumentImportItem item_p)
Returns the importer depending on the imported item, which is given as parameter item_p.

If item_p is null then null will be returned.
Also null will be returned if the DocumentImportItem was importer using DnD-functionality.

Parameters:
item_p - OwDocumentImportItem
Returns:
OwDocumentImporter or null
Since:
2.5.2.0

getDocumentImporter

public com.wewebu.ow.server.app.OwDocumentImporter getDocumentImporter(int i_p)
Returns the importer depending on the imported item, which is given as parameter i_p.

i_p should be >=0 & < getImportedDocumentsCount()
null will be returned if the DocumentImportItem was importer using DnD-functionality.

Parameters:
i_p - int index of the imported document (zero-based)
Returns:
OwDocumentImporter or null
Since:
2.5.2.0

showProcessView

public boolean showProcessView()
If an document was added which DocumentImporter has a post processing view, this method will return true.

Returns:
boolean true only if a document with post process view was added
Since:
2.5.2.0

hasUndefinedObjectClass

public boolean hasUndefinedObjectClass()
If an document was added which OwDocumentImportItem.getObjectClassName() has returned null.

Returns:
boolean true if one document exist which is has not a predefined ObjectClass
Since:
2.5.2.0

setUndefinedObjectClassFlag

protected void setUndefinedObjectClassFlag(boolean value_p)
Set the flag for undefined object class to given value.

This flag notify if a document import item was added without an predefined ObjectClass/Document class.

Parameters:
value_p - boolean
Since:
2.5.2.0

setShowProcessViewFlag

protected void setShowProcessViewFlag(boolean value_p)
Set the flag for post processing view of documents.

This flag notify if there is a document-import-item which should be post processed by a view

Parameters:
value_p - boolean
Since:
2.5.2.0

getClassName

public String getClassName()
Get ObjectClass name which should be used for objects by default.

Return if an default ObjectClass was set in plugins definition

Returns:
String or null
Since:
2.5.2.0

setClassName

public void setClassName(String objectClassname_p)
Set an ObjectClass name as default class.

ATTENTION: This method set only the String reference, you still have to call setObjectClass(OwObjectClass) to create an skeleton object, which can be used

Parameters:
objectClassname_p - String name of ObjectClass
Since:
2.5.2.0

getUserSelectedClassName

public String getUserSelectedClassName()
Return a String which represents the ObjectClass name selected by user action.

Returns:
String or null
Since:
2.5.2.0

setUserSelectedClassName

protected void setUserSelectedClassName(String userSelectedObjectClass_p)
Method to set an ObjectClass name selected by user action.

ATTENTION: This will only the set a String reference to create a skeleton object a call of setObjectClass(OwObjectClass) is still needed

Parameters:
userSelectedObjectClass_p - String ObjectClass name
Since:
2.5.2.0

isValidObjecClass

public boolean isValidObjecClass(String objectClass_p)
Check if the given objectClass name is valid for current context.

Try to resolve the objectClass name to an ObjectClass instance. if an exception is thrown during resolving, this method will return false

Parameters:
objectClass_p - String name (symbolic) of class to check
Returns:
boolean true only if no exception is thrown when retrieve.
Since:
2.5.2.0

onObjectClassViewSelectClass

public void onObjectClassViewSelectClass(com.wewebu.ow.server.ecm.OwObjectClass classDescription_p,
                                         String strPath_p)
                                  throws Exception
Refactoring of handler for OwObjectClass selection by user action.

before 2.5.2 OwCreateMultipleDocumentsDialog was listener of OwObjectClassView selection events.

Specified by:
onObjectClassViewSelectClass in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner
Throws:
Exception
Since:
2.5.2.0
See Also:
OwObjectClassViewListener

preProcessObjectClass

protected com.wewebu.ow.server.ecm.OwObjectClass preProcessObjectClass(com.wewebu.ow.server.ecm.OwObjectClass objCls_p)
                                                                throws com.wewebu.ow.server.exceptions.OwException
(overridable) PreCreation skeleton object handling of ObjectClass, delegated to current OwObjectClassProcessor instance.
Will return the OwObjectClass which should be used as skeleton object class.

By default if getObjectClassProcessor() return null, the same OwObjectClass is returned as provided

Parameters:
objCls_p - OwObjectClass selected for skeleton creation
Returns:
OwObjectClass is used for skeleton object
Throws:
com.wewebu.ow.server.exceptions.OwException
Since:
4.1.1.0

setObjectClassProcessor

public void setObjectClassProcessor(com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor processor)
Setter for OwObjectClassProcessor

Parameters:
processor - OwObjectClassProcessor (can be null)
Since:
4.1.1.0

getObjectClassProcessor

public com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor getObjectClassProcessor()
Getter of current OwObjectClassProcessor

Returns:
OwObjectClassProcessor or null
Since:
4.1.1.0

getParent

public com.wewebu.ow.server.ecm.OwObject getParent()
Specified by:
getParent in interface com.wewebu.ow.server.ecm.OwLocation


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.