Package org.apache.abdera.model

Interface Control

  • All Superinterfaces:
    Base, java.lang.Cloneable, Element, ExtensibleElement, java.lang.Iterable<Element>
    public interface Control
extends ExtensibleElement

    Represents an Atom Publishing Protocol control element.

    The purpose of the control extension is to provide a means for content publishers to embed various publishing-operation specific control parameters within the body of the entry. For instance, the client may wish to mark the entry as a draft, or may wish to ask the publishing server to enable or disable specific extended features for a given entry.

    Per APP Draft-08: 

       pubControl =
      element pub:control {
      atomCommonAttributes,
      pubDraft?
      & extensionElement
   }
 
   pubDraft =
     element pub:draft { "yes" | "no" }
 
  The "pub:control" element MAY appear as a child of an "atom:entry"
  which is being created or updated via the Atom Publishing Protocol.
  The "pub:control" element, if it does appear in an entry, MUST only
  appear at most one time.  The "pub:control" element is considered
  foreign markup as defined in Section 6 of [RFC4287].
 
  The "pub:control" element and its child elements MAY be included in
  Atom Feed or Entry Documents.
 
  The "pub:control" element MAY contain exactly one "pub:draft" element
  as defined here, and MAY contain zero or more extension elements as
  outlined in Section 6 of [RFC4287].  Both clients and servers MUST
  ignore foreign markup present in the pub:control element.

    • Method Detail

      • isDraft

        boolean isDraft()

        Returns true if the entry should not be made publicly visible.

        APP Draft-08: The number of "pub:draft" elements in "pub:control" MUST be zero or one. Its value MUST be one of "yes" or "no". A value of "no" means that the entry MAY be made publicly visible. If the "pub:draft" element is missing then the value MUST be understood to be "no". The pub:draft element MAY be ignored.

        Returns:
        True if this is a draft

      • setDraft

        Control setDraft​(boolean draft)

        Set to "true" if the entry should not be made publicly visible.

        APP Draft-08: The number of "pub:draft" elements in "pub:control" MUST be zero or one. Its value MUST be one of "yes" or "no". A value of "no" means that the entry MAY be made publicly visible. If the "pub:draft" element is missing then the value MUST be understood to be "no". The pub:draft element MAY be ignored.

        Parameters:
        draft - true if app:draft should be set to "yes"

      • unsetDraft

        Control unsetDraft()

        Removes the draft setting completely from the control element.

        APP Draft-08: The number of "pub:draft" elements in "pub:control" MUST be zero or one. Its value MUST be one of "yes" or "no". A value of "no" means that the entry MAY be made publicly visible. If the "pub:draft" element is missing then the value MUST be understood to be "no". The pub:draft element MAY be ignored.