com.sapportals.wcm.service.checkout

Interface ICheckout

public interface ICheckout

Field Summary

static String	CHECKOUT_MODE_AUTOMATICALLY
static 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, String localhost, String localFile, String checkoutMode) Adds a checkout item to the specified resource.
String	getCheckoutHost(IResource resource) Returns the host to which the file is checked out to
String	getCheckoutMode(IResource resource) Gets the current checkout status
String	getCheckoutPath(IResource resource) Returns the path to which the file is checked out to
com.sapportals.portal.security.usermanagement.IUser	getCheckOutUser(IResource resource) Deprecated. As of NetWeaver 7.1, replaced by getCheckOutUserUME(IResource)
com.sap.security.api.IUser	getCheckOutUserUME(IResource resource) Returns the ume 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, String localhost, String localFile, String checkoutMode) Sets a checkout status

Field Detail

CHECKOUT_MODE_USER_DEFINED_PATH

static final String CHECKOUT_MODE_USER_DEFINED_PATH

See Also:

Constant Field Values

CHECKOUT_MODE_AUTOMATICALLY

static final String CHECKOUT_MODE_AUTOMATICALLY

See Also:

Constant Field Values

Method Detail

isCheckoutEnable

boolean isCheckoutEnable(IResource resource)
                         throws com.sapportals.wcm.WcmException

Checks whether a resource can be checked out or not

Parameters:

the - resource to check out

Throws:

com.sapportals.wcm.WcmException

isCheckedOut

boolean isCheckedOut(IResource resource)
                     throws com.sapportals.wcm.WcmException

Returns flag, whether the resource is checked out or not

Throws:

com.sapportals.wcm.WcmException

getCheckOutUser

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

Deprecated. As of NetWeaver 7.1, replaced by getCheckOutUserUME(IResource)

Returns the user who checked out the item

Throws:

com.sapportals.wcm.WcmException

getCheckOutUserUME

com.sap.security.api.IUser getCheckOutUserUME(IResource resource)
                                              throws com.sapportals.wcm.WcmException

Returns the ume user who checked out the item

Throws:

com.sapportals.wcm.WcmException

Since:

NetWeaver 7.1

checkout

boolean checkout(IResource resource,
                 String localhost,
                 String localFile,
                 String checkoutMode)
                 throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

canCancelCheckout

boolean canCancelCheckout(IResource resource)
                          throws com.sapportals.wcm.WcmException

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

Parameters:

the - resource to cancel check out

Throws:

com.sapportals.wcm.WcmException

cancelCheckout

boolean cancelCheckout(IResource resource)
                       throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

canCheckin

boolean canCheckin(IResource resource)
                   throws com.sapportals.wcm.WcmException

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

Parameters:

the - resource to check in

Throws:

com.sapportals.wcm.WcmException

checkin

boolean checkin(IResource resource)
                throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

setCheckoutMode

void setCheckoutMode(IResource resource,
                     String localhost,
                     String localFile,
                     String checkoutMode)
                     throws com.sapportals.wcm.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.

Throws:

com.sapportals.wcm.WcmException

getCheckoutMode

String getCheckoutMode(IResource resource)
                       throws com.sapportals.wcm.WcmException

Gets the current checkout status

Throws:

com.sapportals.wcm.WcmException

getCheckoutHost

String getCheckoutHost(IResource resource)
                       throws com.sapportals.wcm.WcmException

Returns the host to which the file is checked out to

Throws:

com.sapportals.wcm.WcmException

getCheckoutPath

String getCheckoutPath(IResource resource)
                       throws com.sapportals.wcm.WcmException

Returns the path to which the file is checked out to

Throws:

com.sapportals.wcm.WcmException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM