com.sapportals.wcm.service.checkout
Interface ICheckout

[contained in: com.sap.km.cm.service.base.par - km.shared.service.checkout_api.jar]

public interface ICheckout

Field Summary

static java.lang.String	CHECKOUT_MODE_AUTOMATICALLY
static java.lang.String	CHECKOUT_MODE_USER_DEFINED_PATH

Method Summary

boolean	canCancelCheckout(IResource resource) Checks whether the resource can be checkout cancelled by the current user
boolean	cancelCheckout(IResource resource)
boolean	canCheckin(IResource resource) Checks whether the resource can be checked in by the current user
boolean	checkin(IResource resource) Deletes a checkout item belonging to a resource
boolean	checkout(IResource resource, java.lang.String localhost, java.lang.String localFile, java.lang.String checkoutMode) Adds a checkout item to the specified resource.
java.lang.String	getCheckoutHost(IResource resource) Returns the host to which the file is checked out to
java.lang.String	getCheckoutMode(IResource resource) Gets the current checkout status
java.lang.String	getCheckoutPath(IResource resource) Returns the path to which the file is checked out to
com.sapportals.portal.security.usermanagement.IUser	getCheckOutUser(IResource resource) Returns the user who checked out the item
boolean	isCheckedOut(IResource resource) Returns flag, whether the resource is checked out or not
boolean	isCheckoutEnable(IResource resource) Checks whether a resource can be checked out or not
void	setCheckoutMode(IResource resource, java.lang.String localhost, java.lang.String localFile, java.lang.String checkoutMode) Sets a checkout status

Field Detail

CHECKOUT_MODE_USER_DEFINED_PATH

public static final java.lang.String CHECKOUT_MODE_USER_DEFINED_PATH

CHECKOUT_MODE_AUTOMATICALLY

public static final java.lang.String CHECKOUT_MODE_AUTOMATICALLY

Method Detail

isCheckoutEnable

public boolean isCheckoutEnable(IResource resource)
                         throws WcmException

Checks whether a resource can be checked out or not

Parameters:

the - resource to check out

isCheckedOut

public boolean isCheckedOut(IResource resource)
                     throws WcmException

Returns flag, whether the resource is checked out or not

getCheckOutUser

public com.sapportals.portal.security.usermanagement.IUser getCheckOutUser(IResource resource)
                                                                    throws WcmException

Returns the user who checked out the item

checkout

public boolean checkout(IResource resource,
                        java.lang.String localhost,
                        java.lang.String localFile,
                        java.lang.String checkoutMode)
                 throws WcmException

Adds a checkout item to the specified resource. The responisble of the checked out resource is identified by the resource context.

Parameters:

resource - the resource for which the feedback is given

localFile - path of the file to create

localhost - host to which the file will be checked out

Returns:

Boolean to indicate whether storage of the checkout item was successful or failed

canCancelCheckout

public boolean canCancelCheckout(IResource resource)
                          throws WcmException

Checks whether the resource can be checkout cancelled by the current user

Parameters:

the - resource to cancel check out

cancelCheckout

public boolean cancelCheckout(IResource resource)
                       throws WcmException

canCheckin

public boolean canCheckin(IResource resource)
                   throws WcmException

Checks whether the resource can be checked in by the current user

Parameters:

the - resource to check in

checkin

public boolean checkin(IResource resource)
                throws WcmException

Deletes a checkout item belonging to a resource

Parameters:

resource - resource for which the checkout item exists

Returns:

Boolean to indicate whether deletion of the checkout item was successful or failed

setCheckoutMode

public void setCheckoutMode(IResource resource,
                            java.lang.String localhost,
                            java.lang.String localFile,
                            java.lang.String checkoutMode)
                     throws WcmException

Sets a checkout status

Parameters:

checkoutMode - if set to user defined path the user will be asked for the checked out resource while uploading the edited version. If the status is set to automatically the resource will be uploaded without user interaction. In this case the resource should not be moved away from the storing position.

getCheckoutMode

public java.lang.String getCheckoutMode(IResource resource)
                                 throws WcmException

Gets the current checkout status

getCheckoutHost

public java.lang.String getCheckoutHost(IResource resource)
                                 throws WcmException

Returns the host to which the file is checked out to

getCheckoutPath

public java.lang.String getCheckoutPath(IResource resource)
                                 throws WcmException

Returns the path to which the file is checked out to