public interface ICheckout
Modifier and Type | Field and Description |
---|---|
static String |
CHECKOUT_MODE_AUTOMATICALLY |
static String |
CHECKOUT_MODE_USER_DEFINED_PATH |
Modifier and Type | Method and Description |
---|---|
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) |
String |
getCheckoutMode(IResource resource) |
String |
getCheckoutPath(IResource resource) |
com.sapportals.portal.security.usermanagement.IUser |
getCheckOutUser(IResource resource)
Deprecated.
As of NetWeaver 7.1, replaced by
getCheckOutUserUME(IResource) |
IUser |
getCheckOutUserUME(IResource resource) |
boolean |
isCheckedOut(IResource resource)
Checks if a resource is currently checked out
|
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
|
static final String CHECKOUT_MODE_USER_DEFINED_PATH
static final String CHECKOUT_MODE_AUTOMATICALLY
boolean isCheckoutEnable(IResource resource) throws WcmException
resource
- to check outtrue
if checkout resource is enabled, false
otherwiseWcmException
- if an error occurredboolean isCheckedOut(IResource resource) throws WcmException
resource
- to check outtrue
if the resource is checked out, false otherwise
WcmException
- if an error occurredcom.sapportals.portal.security.usermanagement.IUser getCheckOutUser(IResource resource) throws WcmException
getCheckOutUserUME(IResource)
WcmException
IUser getCheckOutUserUME(IResource resource) throws WcmException
resource
- WcmException
- if an error occurredboolean checkout(IResource resource, String localhost, String localFile, String checkoutMode) throws WcmException
resource
- the resource for which the feedback is givenlocalFile
- path of the file to createlocalhost
- host to which the file will be checked outcheckoutMode
- true
if storage of the checkout item was successful, false
otherwiseWcmException
- if an error occurredboolean canCancelCheckout(IResource resource) throws WcmException
resource
- to cancel check outtrue
if the resource checkout cancel is possible, false otherwise
WcmException
- if an error occurredboolean cancelCheckout(IResource resource) throws WcmException
resource
- WcmException
boolean canCheckin(IResource resource) throws WcmException
resource
- to check intrue
if the resource can be checked in by the current user, false
otherwiseWcmException
- if an error occurredboolean checkin(IResource resource) throws WcmException
resource
- resource for which the checkout item existstrue
if deletion of the checkout item was successful, false
otherwiseWcmException
- if an error occurredvoid setCheckoutMode(IResource resource, String localhost, String localFile, String checkoutMode) throws WcmException
resource
- localhost
- localFile
- 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.WcmException
- if an error occurredString getCheckoutMode(IResource resource) throws WcmException
resource
- WcmException
- if an error occurred.String getCheckoutHost(IResource resource) throws WcmException
resource
- WcmException
- if an error occurredString getCheckoutPath(IResource resource) throws WcmException
resource
- WcmException
- if an error occurredAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice