com.sapportals.wcm.service.ice.syndicator

Interface IOffer

All Superinterfaces:

IContentFilter

public interface IOffer
extends IContentFilter

IOffer contains all informations a syndicator has to know about an offer.

Copyright 2004 SAP AG

Method Summary

IOfferComponent	createComponent(String name, com.sapportals.wcm.util.uri.RID rootRID, String prefix, IResourceContext context) Create a new offer component.
ICEAccess	getAccess() Get the default access rules of this offer.
IOfferComponent	getComponent(String name) Get a component of the offer by its name
IOfferComponentList	getComponentList() Get a list of all components of this offer.
ICEDeliveryPolicy	getDeliveryPolicy() Get the default delivery policy of this offer.
String	getDescription() Get the description of the offer.
String	getId() Get the identifier of the offer.
long	getMaxContentSize() Get the maximal content size of the offer.
int	getNoSubscriptions() Get the number of subscriptions on this offer.
void	removeComponent(IOfferComponent component, IResourceContext context) Remove an offer component.
void	setAccess(ICEAccess access, IResourceContext context) Set the default access rules of this offer.
void	setDeliveryPolicy(ICEDeliveryPolicy deliveryPolicy, IResourceContext context) Set the default delivery policy of this offer.
void	setDescription(String description, IResourceContext context) Set the description of the offer.
void	setMaxContentSize(long maxContentSize, IResourceContext context) Set the maximal content size of the offer.

Methods inherited from interface com.sapportals.wcm.service.ice.syndicator.IContentFilter

getAccess, getContentReference

Method Detail

getId

String getId()

Get the identifier of the offer.

Returns:

The identifier of the offer

getDescription

String getDescription()

Get the description of the offer.

Returns:

The description of the offer

setDescription

void setDescription(String description,
                    IResourceContext context)
                    throws ResourceException

Set the description of the offer.

Parameters:

description - The description of the offer

context - The current resource context

Throws:

ResourceException - on error

getDeliveryPolicy

ICEDeliveryPolicy getDeliveryPolicy()

Get the default delivery policy of this offer.

Returns:

The default delivery policy of this offer

setDeliveryPolicy

void setDeliveryPolicy(ICEDeliveryPolicy deliveryPolicy,
                       IResourceContext context)
                       throws ResourceException

Set the default delivery policy of this offer.

Parameters:

deliveryPolicy - The default delivery policy

context - The current Resource context

Throws:

ResourceException - on error

createComponent

IOfferComponent createComponent(String name,
                                com.sapportals.wcm.util.uri.RID rootRID,
                                String prefix,
                                IResourceContext context)
                                throws ResourceException

Create a new offer component.

Parameters:

name - The name of the offer component

rootRID - The uri of the collection to be published

prefix - The prefix that replaces the rootURI

context - The current resource context (containing an authenticated user)

Returns:

The newly created offer part

Throws:

ResourceException - on error

removeComponent

void removeComponent(IOfferComponent component,
                     IResourceContext context)
                     throws ResourceException

Remove an offer component.

Parameters:

component - The offer component to be removed

context - The current resource context (containing an authenticated user)

Throws:

ResourceException - on error

getComponent

IOfferComponent getComponent(String name)

Get a component of the offer by its name

Parameters:

name - The name of the offer component

Returns:

The Component value

getComponentList

IOfferComponentList getComponentList()

Get a list of all components of this offer.

Returns:

A list of all offer components

getAccess

ICEAccess getAccess()

Get the default access rules of this offer.

Returns:

The default access rules of the offer

setAccess

void setAccess(ICEAccess access,
               IResourceContext context)
               throws ResourceException

Set the default access rules of this offer.

Parameters:

access - The default access rules

context - The current resource context

Throws:

ResourceException - on error

getMaxContentSize

long getMaxContentSize()

Get the maximal content size of the offer. If the content size of a resource exceeds this value it will be transfered as ice-item-ref rather than an ice-item.

Returns:

The maximal content size (Long.MAX_VALUE if unlimited)

setMaxContentSize

void setMaxContentSize(long maxContentSize,
                       IResourceContext context)
                       throws ResourceException

Set the maximal content size of the offer. If the content size of a resource exceeds this value it will be transfered as ice-item-ref.

Parameters:

maxContentSize - The maximal content size (Long.MAX_VALUE or -1 if unlimited)

context - The current resource context

Throws:

ResourceException - on error

getNoSubscriptions

int getNoSubscriptions()

Get the number of subscriptions on this offer.

Returns:

The number of subscriptions on this offer.

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