com.wewebu.ow.server.command
Class OwMultipleObjectsProcessCollector

java.lang.Object
  extended by com.wewebu.ow.server.command.OwMultipleObjectsProcessCollector

public class OwMultipleObjectsProcessCollector
extends Object

This is an utility class which holds the elements affected by a multiple objects operation. This class holds the names of correct processed objects, their DMSIDs, the names of objects who fail to be processed, and the localized error messages in case of failure.

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
 class OwMultipleObjectsProcessCollector.OwObjectCollectData
          Object data caching class.
 
Constructor Summary
OwMultipleObjectsProcessCollector()
          Constructor.
 
Method Summary
 void addFailedObjectData(OwMultipleObjectsProcessCollector.OwObjectCollectData collectData_p)
           
 void addProcessedObjectData(OwMultipleObjectsProcessCollector.OwObjectCollectData collectData_p)
           
 void addProcessedObjectFailureMessages(String localizedMessage_p)
          Add the reason why an object cannot be deleted.
 void addUnprocessedObjectData(OwMultipleObjectsProcessCollector.OwObjectCollectData collectData_p)
           
 void clear()
          Clear all lists for this instance.
 OwMultipleObjectsProcessCollector.OwObjectCollectData createCollectData(OwObject object_p)
           
 String getAllErrorMessages()
          Get all error messages as a unified string.
 List getAllErrorNames()
          Get the list with all object names that fail to be processed.
 List getAllErrorObjects()
          Get the list with all objects that fail to be processed.
 List getDisabledObjectNames()
          The list of disabled objects names.
 List getDisabledObjects()
          The list with disabled objects.
 List getFailedObjectsData()
          Returns the list of OwMultipleObjectsProcessCollector.OwObjectCollectData objects that are not processed.
 String getFailToProcessErrorMessages()
          Get the reason why the objects cannot be processed.
 List getFailToProcessNames()
          Get the list with names of objects that fail to be processed.
 Set getProcessedDmsIds()
          Get the list of processed DMSIDs.
 List getProcessedNames()
          Get the names of processed objects.
 List getProcessedObjects()
          Get the list with successfully processed objects
 boolean hasErrors()
          Check if the process operation has errors.
 boolean hasProcessedObjects()
          Check if some of the objects were successfully processed.
 boolean hasProcessErrors()
          Check if the process operation has errors
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OwMultipleObjectsProcessCollector

public OwMultipleObjectsProcessCollector()
Constructor.

Method Detail

createCollectData

public OwMultipleObjectsProcessCollector.OwObjectCollectData createCollectData(OwObject object_p)
                                                                        throws Exception
Throws:
Exception

addUnprocessedObjectData

public void addUnprocessedObjectData(OwMultipleObjectsProcessCollector.OwObjectCollectData collectData_p)

addProcessedObjectData

public void addProcessedObjectData(OwMultipleObjectsProcessCollector.OwObjectCollectData collectData_p)

addFailedObjectData

public void addFailedObjectData(OwMultipleObjectsProcessCollector.OwObjectCollectData collectData_p)

clear

public void clear()
Clear all lists for this instance.


addProcessedObjectFailureMessages

public void addProcessedObjectFailureMessages(String localizedMessage_p)
Add the reason why an object cannot be deleted.

Parameters:
localizedMessage_p - - the message.

getFailToProcessErrorMessages

public String getFailToProcessErrorMessages()
Get the reason why the objects cannot be processed.

Returns:
- the error messages.

hasProcessedObjects

public boolean hasProcessedObjects()
Check if some of the objects were successfully processed.

Returns:
-true - if some of the objects were successfully deleted.

hasProcessErrors

public boolean hasProcessErrors()
Check if the process operation has errors

Returns:
- true - delete operation has errors.

getProcessedDmsIds

public Set getProcessedDmsIds()
Get the list of processed DMSIDs.

Returns:
- the list of DMSIDs.

getProcessedNames

public List getProcessedNames()
Get the names of processed objects.

Returns:
- the list with object names.

getProcessedObjects

public List getProcessedObjects()
Get the list with successfully processed objects

Returns:
java.util.List the list of objects.

getFailToProcessNames

public List getFailToProcessNames()
Get the list with names of objects that fail to be processed.

Returns:
- the list with names.

hasErrors

public boolean hasErrors()
Check if the process operation has errors.

Returns:
- true if the process operation has errors.

getAllErrorNames

public List getAllErrorNames()
Get the list with all object names that fail to be processed.

Returns:
the list with object names.

getAllErrorObjects

public List getAllErrorObjects()
Get the list with all objects that fail to be processed.

Returns:
the list with objects.

getAllErrorMessages

public String getAllErrorMessages()
Get all error messages as a unified string.

Returns:
- the error messages.

getDisabledObjects

public List getDisabledObjects()
The list with disabled objects.

Returns:
disabled object list.

getDisabledObjectNames

public List getDisabledObjectNames()
The list of disabled objects names.

Returns:
list

getFailedObjectsData

public List getFailedObjectsData()
Returns the list of OwMultipleObjectsProcessCollector.OwObjectCollectData objects that are not processed.

Returns:
- a List of OwMultipleObjectsProcessCollector.OwObjectCollectData objects that are not processed.
Since:
3.0.0.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.