com.sapportals.wcm.repository.service.attachment

Interface IAttachment

public interface IAttachment

Interface for the attachment service. Attachments are stored as Files in the Repository "collaboration". Copyright 2004 SAP AG

Method Summary

boolean	addAttachment(IResource resource, String name, String text) Add Attachment of User
boolean	delAttachment(IResource resource, IResource attachres) del one / all Attachments of a Resource
IResourceList	getAttachment(IResource resource) Returns all Attachments of this Resource
com.sapportals.wcm.util.uri.RID	getAttachmentPath(IResource resource) get Path where attachments of resource are stored Path maybe created

Method Detail

getAttachmentPath

com.sapportals.wcm.util.uri.RID getAttachmentPath(IResource resource)
                                                  throws com.sapportals.wcm.WcmException

get Path where attachments of resource are stored Path maybe created

Parameters:

resource - The resource

Returns:

Path-URI

Throws:

com.sapportals.wcm.WcmException

addAttachment

boolean addAttachment(IResource resource,
                      String name,
                      String text)
                      throws com.sapportals.wcm.WcmException

Add Attachment of User

Parameters:

resource - resource to which an attchment is added

Text - Users Attachment

Returns:

True / False

Throws:

com.sapportals.wcm.WcmException

getAttachment

IResourceList getAttachment(IResource resource)
                            throws com.sapportals.wcm.WcmException

Returns all Attachments of this Resource

Parameters:

resource - The resource

Returns:

an IResourceList

Throws:

-

com.sapportals.wcm.WcmException

delAttachment

boolean delAttachment(IResource resource,
                      IResource attachres)

del one / all Attachments of a Resource

Parameters:

resource - - Resource to which the Attachment(s) was saved

attachres - - Attachment Resource (if null - all Attachments are deleted)

Returns:

true/false

Throws:

-

Access Rights

This class can be accessed from:

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