*** This class provides Binary Compatibility only, not Source Compatibility ***

Class DAVEvent

java.lang.Object
All Implemented Interfaces:
AttributesInterface, DAVEntityInterface, DAVItemInterface, Serializable
Direct Known Subclasses:
DAVPackageevent, DAVStoredprocessalert

@SASScope("ALL") @BinaryCompatibilityOnly public class DAVEvent extends DAVItem
Represents event data stored on a DAV server. A serialized XML document (event) is stored as the content of the DAV resource. Doug Melzer
Since:
1.0
See Also:
  • Constructor Details

    • DAVEvent

      public DAVEvent(RepositoryInterface repos, String reposId)
      Creates a new DAVEvent for the entity with a repository id reposId in the repository repos
    • DAVEvent

      public DAVEvent(RepositoryData entity)
      Creates a new DAVEvent from the information in the entity
  • Method Details

    • getEventDocument

      public Document getEventDocument()
      Deprecated.
      Return the event document.

      Returns:
      Document XML document event
    • getEventDocumentAsString

      public String getEventDocumentAsString()
      Return the event document as a string.

      Returns:
      String XML document string
    • setEventDocumentFromString

      public void setEventDocumentFromString(String eventDocString)
      Sets the event document. This is an XML document which becomes the resource's content.
      Parameters:
      eventDocString - The serialized XML document that represents the event
    • setEventDocument

      public void setEventDocument(Document eventDoc)
      Deprecated.
      Sets the event document. This is an XML document which, serialised, becomes the resource's content.
      Parameters:
      eventDoc - The XML document that represents the event
    • promoteProperties

      public void promoteProperties(Element root)
      Promotes a set of useful information from the event header section to distinct DAV properties, so these can be used in PROPFIND's, SEARCH's etc. The property names are assumed to be subelements of the element passed to this function. Elements that are not namespace qualified will be promoted to DAV properties in the Constants.NS_WEBDAV_EVENTX_URI namespace
      Parameters:
      root - The event's header Properties element
    • findPropertyValue

      public String findPropertyValue(String expr)
      Returns the value of a property value in the event.

      Using an XPath expression one can select the element or attribute to be queried for the result. For this XPath expression, three default prefixes are mapped (by default) as follows:
      Constants.NS_EVENTS_PREFIX is mapped to the event namespace Constants. NS_EVENTS_URI
      Constants. NS_PUBLISH_PREFIX is mapped to the publish namespace Constants.NS_PUBLISH_URI
      Constants. NS_STOREDPROCESS_ALERT_PREFIX is mapped to the stored process alert namespace Constants.NS_STOREDPROCESS_ALERT_URI

      The prefixes used are the same as those used in the event definitions and although this is not required, this makes it easier to cut and paste element or attribute names out of these event definitions. If an association other than the defaults is required, then use the XQuery namespace declaration syntax to define a namespace prefix and associate it with a namespace URI, followed by the XPath expression. For example
      declare namespace foo = "http: //example.org" //foo: bar

      Parameters:
      expr - An XPath expression (with optional namespace declaration) which identifies the element or attribute whose value is required
      Returns:
      String The value of the element or attribute identified in the expr parameter