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
Modifier and Type | Method and Description |
---|---|
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
|
void setProperties(OwObject batchobject_p, OwPropertyCollection properties_p, Object mode_p) throws Exception
properties_p
- OwPropertyList list of OwProperties to setmode_p
- mode to use or null to use default mode, @see OwObjectClass.getModes(int)
Exception
void checkout(OwObject batchobject_p, Object mode_p) throws Exception
mode_p
- Object access mode for checked out object, see getCheckoutModesException
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
fPromote_p
- boolean true = create a released version right awaymode_p
- Object checkin mode for objects, see getCheckinModes, or null to use defaultstrObjectClassName_p
- requested class name of the new objectproperties_p
- OwPropertyCollection with new properties to set, or null to use defaultspermissions_p
- OwPermissionCollection ECM specific permissions or null to use defaultscontent_p
- OwContentCollection the new content to set, null to create an empty objectfOverwriteContent_p
- boolean true = content_p overwrites existing content, even if null, false = existing content is keptstrMimeType_p
- String MIME type of the new object contentstrMimeParameter_p
- extra info to the MIME typeException
void save(OwObject batchobject_p, OwContentCollection content_p, String strMimeType_p, String strMimeParameter_p) throws Exception
batchobject_p
- OwObject to perform batch operationcontent_p
- OwContentCollection the new content to set, null to create an empty objectstrMimeType_p
- String MIME type of the new object contentstrMimeParameter_p
- extra info to the MIME typeException
void setPermissions(OwObject batchobject_p, OwPermissionCollection permissions_p) throws Exception
permissions_p
- OwPermissionCollection to setException
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
fPromote_p
- boolean true = create a released version right awaymode_p
- Object checkin mode for objects, see getCheckinModes, or null to use defaultresource_p
- OwResource to add tostrObjectClassName_p
- requested class name of the new objectproperties_p
- OwPropertyCollection with new properties to set, or null to use defaultspermissions_p
- OwPermissionCollection ECM specific permissions or null to use defaultscontent_p
- OwContentCollection the new content to set, null to create an empty objectparent_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 requiredstrMimeType_p
- String MIME type of the new object contentstrMimeParameter_p
- extra info to the MIME typeException
void commit() throws OwException
OwException
void delete(OwObject batchobject_p) throws Exception
batchobject_p
- the object to deleteException
- if the deletion failsvoid move(OwObject object_p, OwObject destination_p, OwObject oldParent_p) throws Exception
object_p
- OwObject reference to add to the new parent/destination object (folder)destination_p
- OwObject (folder) to move the object tooldParent_p
- OwObject old parent / old folder to remove the object from, can be null
Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.