com.hcl.domino.design.DesignEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
package com.hcl.domino.design;

import java.util.List;

import com.hcl.domino.data.Database;
import com.hcl.domino.data.DocumentClass;
import com.hcl.domino.data.DominoDateTime;

/**
 * Represents summary information about a design element in a
 * database.
 * 
 * @param  the {@link DesignElement} type assumed to be represented
 *            by this entry
 * @since 1.21.0
 */
public interface DesignEntry {
  /**
   * Retrieves any comment value for the design element.
   * 
   * @return the design-element comment as a string
   */
  String getComment();
  
  /**
   * Retrieves the document class of the design entry.
   * 
   * @return the entry document class
   * @since 1.39.0
   */
  DocumentClass getDocumentClass();
  
  /**
   * Retrieves the file size for the note, if applicable.
   * 
   * @return the file size for the note as a {@code long}
   * @since 1.39.0
   */
  long getFileSize();
  
  /**
   * Retrieves the set of element flags.
   * 
   * @return the design-element flags as a string
   */
  String getFlags();
  
  /**
   * Retrieves the set of extended element flags.
   * 
   * @return the design-element extended flags as a string
   * @since 1.39.0
   */
  String getFlagsExt();
  
  /**
   * Retrieves the language of the design element, if applicable.
   * 
   * @return the design-element language as a string
   */
  String getLanguage();
  
  /**
   * Retrieves the MIME type of the file-type design element, if applicable.
   * 
   * @return the design-element MIME type as a string
   * @since 1.39.0
   */
  String getMimeType();
  
  /**
   * Retrieves the last-modified time of the entry.
   * 
   * @return the last-modified time of the entry as a {@link DominoDateTime}
   * @since 1.39.0
   */
  DominoDateTime getModified();
  
  /**
   * Retrieves the note ID of the underlying note for the design
   * element.
   * 
   * @return the design-element note ID
   */
  int getNoteID();
  
  /**
   * Retrieves the universal ID of the underlying note for the design
   * element.
   * 
   * @return the design-element UNID
   */
  String getUNID();
  
  /**
   * Retrieves the name of the last user to modify the note.
   * 
   * @return the last modification user
   * @since 1.39.0
   */
  String getUpdatedBy();
  
  /**
   * Retrieves the primary title of the design element.
   * 
   * @return the primary title of the design element as a string
   * @since 1.39.0
   */
  String getTitle();
  
  /**
   * Retrieves the title and any aliases of the design element.
   * 
   * @return the design-element titles and aliases as a {@link List}
   *         of strings
   */
  List getTitles();
  
  /**
   * Determines whether any of the element's titles match the provided
   * title value. This ignores parentheses and accounts for aliases.
   * 
   * @param title the title to check
   * @return {@code true} if any of the element's titles are a match;
   *         {@code false} otherwise
   * @since 1.40.0
   */
  boolean matchesTitleValue(String title);
  
  /**
   * Attempts to load the design element from the specified database, which
   * should be the database that was originally queried.
   * 
   * The actual return type will depend on the type of design element.
   * 
   * @param database the database to load the design element from
   * @return the design element as an implementation class of {@link DesignElement}
   */
  T toDesignElement(final Database database);
}