public interface ITimebasedPublishServiceManager extends IRepositoryService, IEventSender
handle...
methods at regular intervals.
A namespace filter is responsible for finding out, whether a resource is visible
or hidden.
Passing null as an argument in methods causes an exception unless otherwise stated in the method description.
Whether a resource is visible or hidden depends on the user: saveValidToXdays(ICollection impFolder, Integer validToXdays)
,
readValidToXdays(ICollection impFolder)
.Modifier and Type | Method and Description |
---|---|
ITimebasedPublishEvent |
getTimebasedPublishEventTemplate(int type)
Get a
ITimebasedPublishEvent -template for the given
ITimebasedPublishEvent -type. |
void |
handleBeforeExpiryResources()
Searches for all resources for which a notification have to be send before they expires.
|
void |
handleInvisibleResources()
Searches for all resources which have become invisible since the last call of this method and sends an event for
every resource to inform other services about these hidden resources.
|
void |
handleVisibleResources()
Searches for all resources which have become visible since the last call of this method and sends an event for
every resource to inform other services about the visibility of these resources.
|
boolean |
isTimebasePublishEnabled(IResource impResource)
Checks whether time-based publishing has been enabled for the resource.
|
boolean |
isVisible(IResource impResource)
Checks whether all conditions for the visibility of the time-based publishing service have been fullfilled.
|
Date |
readInvalidDate(IResource impResource)
Reads the date on which a resource will be hidden.
|
Date |
readValidDate(IResource impResource)
Reads the date on which a resource will be visible.
|
Integer |
readValidToXdays(ICollection impFolder)
Reads the days before the documents in the folder becomes invalid.
|
void |
saveInvalidDate(IResource impResource,
Date invalidDate)
Saves the date on which a resource will become visible.
|
void |
saveValidDate(IResource impResource,
Date validDate)
Saves the date on which a resource will be hidden.
|
void |
saveValidToXdays(ICollection impFolder,
Integer validToXdays)
Saves the value of the property which is displayed as the
'How many days before validity expires' when lifetime is activated on folder
|
void |
setTimebasePublishEnabled(ICollection impFolder,
boolean enabled)
Enables the time-based publishing service for a folder
When the time-based publishing service is enabled for a folder, the visibility of all children
within this folder is controlled by the time-based publishing service.
|
acceptServletCall, getDescription, getDescription, getID, getServiceType
getEvents
void setTimebasePublishEnabled(ICollection impFolder, boolean enabled) throws WcmException
impFolder
- the folder to enable the service forenabled
- true, if the service is enabledWcmException
- no descriptionboolean isTimebasePublishEnabled(IResource impResource) throws WcmException
impResource
is a collection, the settings for this collection are checked. Otherwise, the
settings for the parent collection of the impResource are checked. Returns false if the impResource is null.impResource
- resource to checkWcmException
- no descriptionvoid saveValidDate(IResource impResource, Date validDate) throws WcmException
validDate
deletes the
previous setting.impResource
- the current resourcevalidDate
- the date on which the resource becomes validWcmException
- no descriptionvoid saveInvalidDate(IResource impResource, Date invalidDate) throws WcmException
invalidDate
deletes the
previous setting.impResource
- the current resourceinvalidDate
- the date on which the resource becomes invalidWcmException
- no descriptionvoid saveValidToXdays(ICollection impFolder, Integer validToXdays) throws WcmException
impFolder
- The folder for which the lifetime is enabledvalidToXdays
- How many days before documents in the folder becomes invalid, subscribed users should receive a notificationWcmException
- no descriptionDate readValidDate(IResource impResource) throws WcmException
impResource
- the current resourceWcmException
- no descriptionDate readInvalidDate(IResource impResource) throws WcmException
impResource
- the current resourceWcmException
- no descriptionInteger readValidToXdays(ICollection impFolder) throws WcmException
impFolder
- The folder for which the lifetime is enabledWcmException
- Exception raised in failure situationboolean isVisible(IResource impResource) throws WcmException
namespace filter
impResource
- the current resourceWcmException
- no descriptionvoid handleVisibleResources() throws WcmException
scheduler
task
WcmException
- no descriptionvoid handleInvisibleResources() throws WcmException
scheduler task
WcmException
void handleBeforeExpiryResources() throws WcmException
WcmException
- Exception raised in failure situationITimebasedPublishEvent getTimebasedPublishEventTemplate(int type)
ITimebasedPublishEvent
-template for the given
ITimebasedPublishEvent
-type.type
- the ITimebasedPublishEvent
-type to get the template for.ITimebasedPublishEvent
-template for the given type
or null
if the given type is not valid.Access 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