package de.smartics.projectdoc.atlassian.confluence.api.domain;
/**
* A * Returns all artificial properties.
view on a projectdoc document property for public access through the
* published API.
*/
public interface ProjectdocDocumentProperty {
/**
* @returnReturns allthe artificialname properties.of Maythe beproperty.
empty, but is never*
* @return the name of the property, never <code>null</code>.
*/
Map<String, DocumentProperty> getArtificialPropertiesString getName();
/**
* Returns all propertiesthe rendered value as based on the storage format found in the
* projectdoc document.
* <p>
* @return all properties. May be empty, but is never <code>null</code>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.
*/
Map<String, DocumentProperty> getPropertiesString getRenderedValue();
/**
* Returns the normalized version of the rendered property value.
* <p>
* @paramThis is the nametext representation of the property value.
to return.* <code>null</code> will be</p>
*
* @return the normalized rendered value of the property.
*/
String getNormalizedRenderedValue();
/**
returned,* ifReturns the propertyoriginal value isas unknownfound toin the projectdoc document in storage
* format.
*/
@Nullable* @return the original value of the property.
DocumentProperty getProperty( */
String propertyNamegetOriginalValue();
/**
* Returns the renderednormalized propertyversion identifiedof bythe theoriginal property keyvalue.
The* property<p>
* keyThis is the I18n resource key text representation of the property value.
* </p>
*
@param* propertyKey@return the key to the name ofnormalized original value of the property.
*/
String getNormalizedOriginalValue();
/**
* Checks if the property to returnis actually a section.
*
* @return <code>true</code> if <code>null</code> will be returned, ifthe property is actually a section,
* <code>false</code> if it is actually a property.
*/
boolean isSection();
/**
* Checks whether or not the property is unknown to associated with the given control.
*
* @param controlName the name of the control documentto check.
* @return <code>true</code> if the property has this control attached,
@Nullable* <code>false</code> otherwise.
*/
DocumentPropertyboolean getPropertyByKeyhasControl(String propertyKeycontrolName);
} |