com.sapportals.wcm.repository.service.timebasedpublish
Class TimebasedPublishConstants

[contained in: com.sap.km.cm.repository.service.base.par - km.shared.repository.service.timebasedpublish_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.repository.service.timebasedpublish.TimebasedPublishConstants

public class TimebasedPublishConstants

extends java.lang.Object

The class provides access to the property names which the time-based publishing service uses. Some service-specific application properties are needed for the time-based publishing service to work. These properties are accessed with the methods IResource.getProperties() and IResource.getProperty(IPropertyName PropName) . The IPropertyName objects for these properties can be accessed by the different methods defined in this class.

Field Summary

static java.lang.String	CONNECTIONPOOLID_PROP_KEY
static java.lang.String	VALIDITYNAMESPACE

Constructor Summary

TimebasedPublishConstants()

Method Summary

static IPropertyName	getDisplayValidFromPropName() Gets the name of the property which is displayed as the 'valid from' property for a resource.
static IPropertyName	getDisplayValidToPropName() Gets the name of the property which is to be displayed as the 'valid until' property for a resource.
static IPropertyName	getTimebasePublishEnabledName() Gets the name of the property which determines if time-based publishing is enabled for a resource.
static IPropertyName	getValidFromPropName() Gets the name of the property which determines the point in time at which a resource is to be made visible by the scheduler task.
static IPropertyName	getValidToPropName() Gets the name of the property which determines the point in time at which a resource is to be made invisible by the scheduler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONNECTIONPOOLID_PROP_KEY

public static final java.lang.String CONNECTIONPOOLID_PROP_KEY

VALIDITYNAMESPACE

public static final java.lang.String VALIDITYNAMESPACE

Constructor Detail

TimebasedPublishConstants

public TimebasedPublishConstants()

Method Detail

getTimebasePublishEnabledName

public static IPropertyName getTimebasePublishEnabledName()
                                                   throws ResourceException

Gets the name of the property which determines if time-based publishing is enabled for a resource. This IPropertyName defines a property which is normally set for collections to define whether the visiblity of all children that belong to this collection is controlled by the time-based publishing service.

Returns:

the TimebasePublishEnabledName value

Throws:

ResourceException - exception raised in failure situation

getValidFromPropName

public static IPropertyName getValidFromPropName()
                                          throws ResourceException

Gets the name of the property which determines the point in time at which a resource is to be made visible by the scheduler task. This property is used by the method ITimebasedPublishServiceManager.handleVisibleResources() to find all resources which have to be made visible at a certain point in time. The method deletes this property for each resource it finds in order to make it visible.

Returns:

the ValidFromPropName value

Throws:

ResourceException - exception raised in failure situation

getValidToPropName

public static IPropertyName getValidToPropName()
                                        throws ResourceException

Gets the name of the property which determines the point in time at which a resource is to be made invisible by the scheduler. This property is used by the method ITimebasedPublishServiceManager.handleInvisibleResources() to find all resources which have to be hidden at a certain point in time. The method deletes this property for each resource it finds in order to hide it.

Returns:

the ValidToPropName value

Throws:

ResourceException - exception raised in failure situation

getDisplayValidFromPropName

public static IPropertyName getDisplayValidFromPropName()
                                                 throws ResourceException

Gets the name of the property which is displayed as the 'valid from' property for a resource. This property has no direct influence on the visibility of a resource. It is a copy of the property that controls visibility.

Returns:

the DisplayValidFromPropName value

Throws:

ResourceException - exception raised in failure situation

getDisplayValidToPropName

public static IPropertyName getDisplayValidToPropName()
                                               throws ResourceException

Gets the name of the property which is to be displayed as the 'valid until' property for a resource. This property has no direct influence on the visibility of a resource. It is a copy of the property that controls visibility.

Returns:

the DisplayValidToPropName value

Throws:

ResourceException - exception raised in failure situation