package de.smartics.projectdoc.atlassian.confluence.api.domain;

import com.atlassian.confluence.pages.Page;

import java.util.Date;

import javax.annotation.Nullable;

/**
 * A view on a projectdoc document for public access through the published API.
 */
public interface ProjectdocDocument {
  /**
   * Returns the page if the document refers actually to a page. If it is not a
   * page, <code>null</code> is returned.
   *
   * @return a reference to the page or <code>null</code>.
   */
  @Nullable
  Page getPage();

  /**
   * Returns the unique identifier of the Confluence document.
   *
   * @return the unique identifier of the Confluence document.
   */
  long getDocumentId();

  /**
   * Returns the key of the space the document is part of.
   *
   * @return the key of the space the document is part of.
   */
  String getSpaceKey();

  /**
   * Returns the title of the document in Confluence.
   *
   * @return the title of the document in Confluence.
   */
  String getTitle();

  /**
   * Returns the display title of the document in Confluence.
   *
   * @return the display title of the document in Confluence.
   */
  String getDisplayTitle();

  /**
   * Returns the path to the document within Confluence.
   *
   * @return the path to the document within Confluence.
   */
  String getUrlPath();

  /**
   * Returns the last modification date of the document in Confluence.
   *
   * @return the last modification date of the document in Confluence.
   */
  Date getLastModificationDate();

  /**
   * Returns the rendered property.
   *
   * @param the name of the property to return. <code>null</code> will be
   *        returned, if the property is unknown to the document.
   */
  @Nullable
  ProjectdocDocumentProperty getProperty(String propertyName);

  /**
   * Returns the rendered property identified by the property key. The property
   * key is the I18n resource key.
   *
   * @param propertyKey the key to the name of the property to return.
   *        <code>null</code> will be returned, if the property is unknown to
   *        the document.
   */
  @Nullable
  ProjectdocDocumentProperty getPropertyByKey(String propertyKey);
}

package de.smartics.projectdoc.atlassian.confluence.api.domain;

/**
 * A view on a projectdoc document property for public access through the
 * published API.
 */
public interface ProjectdocDocumentProperty {
  /**
   * Returns the name of the property.
   *
   * @return the name of the property, never <code>null</code>.
   */
  String getName();

  /**
   * Returns the rendered value as based on the storage format found in the
   * projectdoc document.
   * <p>
   * This is the value with style information. For instance, if the value is
   * boxed in a div element with class attributes, this structure is returned.
   * </p>
   *
   * @return the rendered value of the property.
   */
  String getRenderedValue();

  /**
   * Returns the normalized version of the rendered property value.
   * <p>
   * This is the text representation of the property value.
   * </p>
   *
   * @return the normalized rendered value of the property.
   */
  String getNormalizedRenderedValue();

  /**
   * Returns the original value as found in the projectdoc document in storage
   * format.
   *
   * @return the original value of the property.
   */
  String getOriginalValue();

  /**
   * Returns the normalized version of the original property value.
   * <p>
   * This is the text representation of the property value.
   * </p>
   *
   * @return the normalized original value of the property.
   */
  String getNormalizedOriginalValue();

  /**
   * Checks if the property is actually a section.
   *
   * @return <code>true</code> if the property is actually a section,
   *         <code>false</code> if it is actually a property.
   */
  boolean isSection();

  /**
   * Checks whether or not the property is associated with the given control.
   *
   * @param controlName the name of the control to check.
   * @return <code>true</code> if the property has this control attached,
   *         <code>false</code> otherwise.
   */
  boolean hasControl(String controlName);
}