com.wewebu.ow.server.ecm

Interface OwVersionSeries

public interface OwVersionSeries

Base interface for Versions Series. A Version Series is attached to a versionable object and switches between versions.
NOTE: a document is always working on a specific version. With the VersionSeries a document can select a different version.

To be implemented with the specific ECM system.

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

Methods

Modifier and Type	Method and Description
String	getId() Return a String which represent the version series Id.
OwVersion	getLatest() retrieve the latest version in the series
OwObject	getObject(OwVersion version_p) get a OwObject for a given OwVersion
OwVersion	getReleased() retrieve the released version in the series
OwVersion	getReservation() retrieve the reservation (intermediate after checkout) version in the series
Collection	getVersions(Collection properties_p, OwSort sort_p, int iMaxSize_p) get the available version objects

Method Detail

getObject

OwObject getObject(OwVersion version_p)
                   throws Exception

get a OwObject for a given OwVersion

Parameters:

version_p - OwVersion object identifying the OwObject

Returns:

OwObject

Throws:

Exception

getVersions

Collection getVersions(Collection properties_p,
                     OwSort sort_p,
                     int iMaxSize_p)
                       throws Exception

get the available version objects

Parameters:

properties_p - Collection of property names to retrieve for cached fast access

sort_p - OwSort

iMaxSize_p - maximum number of items to retrieve

Returns:

Collection of OwVersion objects, use getObject to obtain a OwObject

Throws:

Exception

getLatest

OwVersion getLatest()
                    throws Exception

retrieve the latest version in the series

Returns:

OwVersion, use getObject to obtain a OwObject

Throws:

Exception

getReleased

OwVersion getReleased()
                      throws Exception

retrieve the released version in the series

Returns:

OwVersion, use getObject to obtain a OwObject

Throws:

Exception

getReservation

OwVersion getReservation()
                         throws Exception

retrieve the reservation (intermediate after checkout) version in the series

Returns:

OwVersion or null if not checked out of ECM system does not support reservations, use getObject to obtain a OwObject)

Throws:

Exception

getId

String getId()

Return a String which represent the version series Id.

Method is available since 3.2.0.0

Returns:

String version series id of this version series

Since:

3.2.0.0