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
Modifier and Type | Field and Description |
---|---|
protected com.wewebu.ow.server.ecm.OwObject |
m_parentFolder
the parent folder, required for special handling of virtual folders
|
protected List<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> |
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
|
Constructor and Description |
---|
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
|
Modifier and Type | Method and Description |
---|---|
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
|
void |
detach() |
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<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> |
getPropertyInfos()
Collection of OwPropertyInfo objects defining read only properties.
|
org.alfresco.wd.ui.conf.OwPropertyListConfiguration |
getPropertyListConfiguration()
Get the currently defined ProeprtyList configuration.
|
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
|
void |
setPropertyListConfiguration(org.alfresco.wd.ui.conf.OwPropertyListConfiguration propertyListConfiguration)
Set a specific PropertyList configuration
|
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.
|
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getPersistentAttributeBagWriteable, getSafeAttribute, hasAttribute, init, remove, save, setAttribute, update
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
protected com.wewebu.ow.server.ecm.OwResource m_resource
protected com.wewebu.ow.server.ecm.OwObject m_parentFolder
protected List<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> m_propertyInfos
protected String strUserSelectedClassName
public OwAddMultiDocumentsDocument(com.wewebu.ow.server.ecm.OwResource resource_p, com.wewebu.ow.server.ecm.OwObject parentFolder_p)
public com.wewebu.ow.server.ecm.OwResource getResource()
OwResource
where the new objects are created.getResource
in interface com.wewebu.ow.server.ecm.OwLocation
OwResource
where the new objects are created.public Collection<org.alfresco.wd.ui.conf.prop.OwPropertyInfo> getPropertyInfos()
public void setObjectClass(com.wewebu.ow.server.ecm.OwObjectClass objectClass_p) throws Exception
OwUpateCodes.SET_NEW_OBJECT
.objectClass_p
- OwObjectClassException
com.wewebu.ow.server.exceptions.OwInvalidOperationException
- if OwNetwork.createObjectSkeleton(OwbjectClass, OwResource} returns null
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
objectClass_p
- context_p
- Exception
public com.wewebu.ow.server.ecm.OwObjectSkeleton getSkeletonObject(boolean fRenew_p) throws Exception
fRenew_p
- a boolean
OwObjectSkeleton
Exception
public com.wewebu.ow.server.app.OwDocumentImportItem getImportedDocument(int idx_p)
Can throw IndexOutOfBoundsException if
idx_p >
or less than 0 (zero)getImportedDocumentsCount()
idx_p
- int index of item to be returnedgetImportedDocumentsCount()
public int getImportedDocumentsCount()
public void releaseImportedDocument(com.wewebu.ow.server.app.OwDocumentImportItem importedDocument_p) throws Exception
OwDocumentImportItem.release()
and afterwards the caching entry from structure is cleared.importedDocument_p
- OwDocumentImportItem
- the document to be releasedException
- if release of OwDocumentImportItem creates a failurepublic void releaseImportedDocuments() throws Exception
OwDocumentImportItem.release()
and afterwards the caching structure is cleared.Exception
- if release of OwDocumentImportItem creates a failurepublic void onDocumentImported(com.wewebu.ow.server.app.OwDocumentImporter importer_p, com.wewebu.ow.server.app.OwDocumentImportItem importedDocument_p) throws Exception
onDocumentImported
in interface com.wewebu.ow.server.app.OwDocumentImporterCallback
Exception
public com.wewebu.ow.server.app.OwDocumentImporter getDocumentImporter(com.wewebu.ow.server.app.OwDocumentImportItem 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.
item_p
- OwDocumentImportItemnull
public com.wewebu.ow.server.app.OwDocumentImporter getDocumentImporter(int i_p)
i_p
should be >=0 & < getImportedDocumentsCount()
null
will be returned if the DocumentImportItem
was importer using DnD-functionality.
i_p
- int index of the imported document (zero-based)null
public boolean showProcessView()
true
only if a document with post process view was addedpublic boolean hasUndefinedObjectClass()
OwDocumentImportItem.getObjectClassName()
has returned null
.true
if one document exist which is has not a predefined ObjectClassprotected void setUndefinedObjectClassFlag(boolean value_p)
This flag notify if a document import item was added without an predefined ObjectClass/Document class.
value_p
- booleanprotected void setShowProcessViewFlag(boolean value_p)
This flag notify if there is a document-import-item which should be post processed by a view
value_p
- booleanpublic String getClassName()
Return if an default ObjectClass was set in plugins definition
null
public void setClassName(String objectClassname_p)
ATTENTION: This method set only the String reference,
you still have to call setObjectClass(OwObjectClass)
to create an skeleton object, which can be used
objectClassname_p
- String name of ObjectClasspublic String getUserSelectedClassName()
null
protected void setUserSelectedClassName(String userSelectedObjectClass_p)
ATTENTION: This will only the set a String reference
to create a skeleton object a call of setObjectClass(OwObjectClass)
is still needed
userSelectedObjectClass_p
- String ObjectClass namepublic boolean isValidObjecClass(String objectClass_p)
Try to resolve the objectClass name to an ObjectClass instance. if an exception is thrown during resolving, this method will return false
objectClass_p
- String name (symbolic) of class to checkpublic void onObjectClassViewSelectClass(com.wewebu.ow.server.ecm.OwObjectClass classDescription_p, String strPath_p) throws Exception
before 2.5.2 OwCreateMultipleDocumentsDialog was listener of OwObjectClassView selection events.
onObjectClassViewSelectClass
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner
Exception
OwObjectClassViewListener
protected com.wewebu.ow.server.ecm.OwObjectClass preProcessObjectClass(com.wewebu.ow.server.ecm.OwObjectClass objCls_p) throws com.wewebu.ow.server.exceptions.OwException
By default if getObjectClassProcessor()
return null, the same OwObjectClass is returned as provided
objCls_p
- OwObjectClass selected for skeleton creationcom.wewebu.ow.server.exceptions.OwException
public void setObjectClassProcessor(com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor processor)
processor
- OwObjectClassProcessor (can be null)public com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor getObjectClassProcessor()
public com.wewebu.ow.server.ecm.OwObject getParent()
getParent
in interface com.wewebu.ow.server.ecm.OwLocation
public org.alfresco.wd.ui.conf.OwPropertyListConfiguration getPropertyListConfiguration()
public void setPropertyListConfiguration(org.alfresco.wd.ui.conf.OwPropertyListConfiguration propertyListConfiguration)
propertyListConfiguration
- OwPropertyListConfigurationpublic void detach()
detach
in class com.wewebu.ow.server.ui.OwEventTarget
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.