com.wewebu.ow.server.ecm
Interface OwBatch


public interface OwBatch

Interface for batch operations.
Each operation is stored as pending and committed to the ECM system upon method call commit.
To retrieve a batch see OwRepository.openBatch()

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


Method Summary
 void checkin(OwObject batchobject_p, boolean fPromote_p, Object mode_p, String strObjectClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p, OwContentCollection content_p, boolean fOverwriteContent_p, String strMimeType_p, String strMimeParameter_p)
          checkin
 void checkout(OwObject batchobject_p, Object mode_p)
          checkout
 void commit()
          Commits all pending operations
 String createNewObject(boolean fPromote_p, Object mode_p, OwResource resource_p, String strObjectClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p, OwContentCollection content_p, OwObject parent_p, String strMimeType_p, String strMimeParameter_p)
          creates a new object on the ECM System using the given parameters has additional promote and checkin mode parameters for versionable objects
 void delete(OwObject batchobject_p)
          Deletes an object and all its references from DB.
 void demote(OwObject batchobject_p)
          demote version
 void move(OwObject object_p, OwObject destination_p, OwObject oldParent_p)
          Moves an object reference to a new parent/destination object (folder).
 void promote(OwObject batchobject_p)
          promote version
 void save(OwObject batchobject_p, OwContentCollection content_p, String strMimeType_p, String strMimeParameter_p)
          set the content to the checked out object
 void setPermissions(OwObject batchobject_p, OwPermissionCollection permissions_p)
          set the permissions object
 void setProperties(OwObject batchobject_p, OwPropertyCollection properties_p, Object mode_p)
          set the properties in the object
 

Method Detail

setProperties

void setProperties(OwObject batchobject_p,
                   OwPropertyCollection properties_p,
                   Object mode_p)
                   throws Exception
set the properties in the object

Parameters:
properties_p - OwPropertyList list of OwProperties to set
mode_p - mode to use or null to use default mode, @see OwObjectClass.getModes(int)
Throws:
Exception

checkout

void checkout(OwObject batchobject_p,
              Object mode_p)
              throws Exception
checkout

Parameters:
mode_p - Object access mode for checked out object, see getCheckoutModes
Throws:
Exception

checkin

void checkin(OwObject batchobject_p,
             boolean fPromote_p,
             Object mode_p,
             String strObjectClassName_p,
             OwPropertyCollection properties_p,
             OwPermissionCollection permissions_p,
             OwContentCollection content_p,
             boolean fOverwriteContent_p,
             String strMimeType_p,
             String strMimeParameter_p)
             throws Exception
checkin

Parameters:
fPromote_p - boolean true = create a released version right away
mode_p - Object checkin mode for objects, see getCheckinModes, or null to use default
strObjectClassName_p - requested class name of the new object
properties_p - OwPropertyCollection with new properties to set, or null to use defaults
permissions_p - OwPermissionCollection ECM specific permissions or null to use defaults
content_p - OwContentCollection the new content to set, null to create an empty object
fOverwriteContent_p - boolean true = content_p overwrites existing content, even if null, false = existing content is kept
strMimeType_p - String MIME type of the new object content
strMimeParameter_p - extra info to the MIME type
Throws:
Exception

promote

void promote(OwObject batchobject_p)
             throws Exception
promote version

Throws:
Exception

demote

void demote(OwObject batchobject_p)
            throws Exception
demote version

Throws:
Exception

save

void save(OwObject batchobject_p,
          OwContentCollection content_p,
          String strMimeType_p,
          String strMimeParameter_p)
          throws Exception
set the content to the checked out object

Parameters:
batchobject_p - OwObject to perform batch operation
content_p - OwContentCollection the new content to set, null to create an empty object
strMimeType_p - String MIME type of the new object content
strMimeParameter_p - extra info to the MIME type
Throws:
Exception

setPermissions

void setPermissions(OwObject batchobject_p,
                    OwPermissionCollection permissions_p)
                    throws Exception
set the permissions object

Parameters:
permissions_p - OwPermissionCollection to set
Throws:
Exception

createNewObject

String createNewObject(boolean fPromote_p,
                       Object mode_p,
                       OwResource resource_p,
                       String strObjectClassName_p,
                       OwPropertyCollection properties_p,
                       OwPermissionCollection permissions_p,
                       OwContentCollection content_p,
                       OwObject parent_p,
                       String strMimeType_p,
                       String strMimeParameter_p)
                       throws Exception
creates a new object on the ECM System using the given parameters has additional promote and checkin mode parameters for versionable objects

Parameters:
fPromote_p - boolean true = create a released version right away
mode_p - Object checkin mode for objects, see getCheckinModes, or null to use default
resource_p - OwResource to add to
strObjectClassName_p - requested class name of the new object
properties_p - OwPropertyCollection with new properties to set, or null to use defaults
permissions_p - OwPermissionCollection ECM specific permissions or null to use defaults
content_p - OwContentCollection the new content to set, null to create an empty object
parent_p - OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is required
strMimeType_p - String MIME type of the new object content
strMimeParameter_p - extra info to the MIME type
Returns:
String the ECM ID of the new created object
Throws:
Exception

commit

void commit()
            throws OwException
Commits all pending operations

Throws:
OwException

delete

void delete(OwObject batchobject_p)
            throws Exception
Deletes an object and all its references from DB.

Parameters:
batchobject_p - the object to delete
Throws:
Exception - if the deletion fails
Since:
2.5.2.0

move

void move(OwObject object_p,
          OwObject destination_p,
          OwObject oldParent_p)
          throws Exception
Moves an object reference to a new parent/destination object (folder).

Parameters:
object_p - OwObject reference to add to the new parent/destination object (folder)
destination_p - OwObject (folder) to move the object to
oldParent_p - OwObject old parent / old folder to remove the object from, can be null
Throws:
Exception
Since:
2.5.2.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.