RepositoryVersioningHelper (Cocoon API 2.1.12-dev [March 20 2012])

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cocoon.components.repository.helpers
Interface RepositoryVersioningHelper

All Known Implementing Classes:: WebDAVRepositoryVersioningHelper

public interface RepositoryVersioningHelper

A versioning helper interface intended to be used by flowscripts or corresponding wrapper components.

Method Summary

boolean checkin(String uri)
          checkin a resource

boolean checkout(String uri)
          checkout a resource

List getVersions(String uri)
          get the version history of a resource

boolean isVersioned(String uri)
          check if a resource is under version control

boolean setVersioned(String uri, boolean versioned)
          set a resource under version control

boolean uncheckout(String uri)
          undo a previously done checkout

Method Summary
`boolean`	`checkin(String uri)` checkin a resource
`boolean`	`checkout(String uri)` checkout a resource
`List`	`getVersions(String uri)` get the version history of a resource
`boolean`	`isVersioned(String uri)` check if a resource is under version control
`boolean`	`setVersioned(String uri, boolean versioned)` set a resource under version control
`boolean`	`uncheckout(String uri)` undo a previously done checkout

Method Detail

checkout

boolean checkout(String uri)
                 throws ProcessingException

checkout a resource

Parameters:: uri - the uri of the resource.
Returns:: a boolean indicating success.
Throws:: ProcessingException

checkin

boolean checkin(String uri)
                throws ProcessingException

checkin a resource

Parameters:: uri - the uri of the resource.
Returns:: a boolean indicating success.
Throws:: ProcessingException

uncheckout

boolean uncheckout(String uri)
                   throws ProcessingException

undo a previously done checkout

Parameters:: uri - the uri of the resource.
Returns:: a boolean indicating success.
Throws:: ProcessingException

isVersioned

boolean isVersioned(String uri)
                    throws ProcessingException

check if a resource is under version control

Parameters:: uri - the uri of the resource.
Returns:: a boolean indicating if the resource is under version control.
Throws:: ProcessingException

setVersioned

boolean setVersioned(String uri,
                     boolean versioned)
                     throws ProcessingException

set a resource under version control

Parameters:: uri - the uri of the resource.; versioned - if true the resource is set under version control.
Returns:: a boolean indicating success.
Throws:: ProcessingException

getVersions

List getVersions(String uri)
                 throws ProcessingException

get the version history of a resource

Parameters:: uri - the uri of the resource.
Returns:: a list containing the versions.
Throws:: ProcessingException