com.mindoo.domino.jna.INoteSummary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jna Show documentation
Java project to access the HCL Domino C API using Java Native Access (JNA)
There is a newer version: 0.9.53
package com.mindoo.domino.jna;

import java.util.Calendar;
import java.util.List;

public interface INoteSummary {

	/**
	 * Convenience function that converts a summary value to a string
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if value is empty or is not a string
	 * @return string value or null
	 */
	public String getAsString(String itemName, String defaultValue);
	
	/**
	 * Convenience function that converts a summary value to an abbreviated name
	 * 
	 * @param itemName item name, case insensitive
	 * @return name or null
	 */
	public String getAsNameAbbreviated(String itemName);
	
	/**
	 * Convenience function that converts a summary value to an abbreviated name
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue value to be used of item not found
	 * @return name or default value
	 */
	public String getAsNameAbbreviated(String itemName, String defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a list of abbreviated names
	 * 
	 * @param itemName item name, case insensitive
	 * @return names or null
	 */
	public List getAsNamesListAbbreviated(String itemName);
	
	/**
	 * Convenience function that converts a summary value to a list of abbreviated names
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a string or string list
	 * @return names or default value if not found
	 */
	public List getAsNamesListAbbreviated(String itemName, List defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a string list
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a string or string list
	 * @return string list value or null
	 */
	public List getAsStringList(String itemName, List defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a {@link Calendar}
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a Calendar
	 * @return calendar value or null
	 */
	public Calendar getAsCalendar(String itemName, Calendar defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a {@link NotesTimeDate}
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a NotesTimeDate
	 * @return NotesTimeDate value or null
	 */
	public NotesTimeDate getAsTimeDate(String itemName, NotesTimeDate defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a {@link Calendar} list
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a Calendar
	 * @return calendar list value or null
	 */
	public List getAsCalendarList(String itemName, List defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a {@link NotesTimeDate} list
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a NotesTimeDate list
	 * @return NotesTimeDate list value or null
	 */
	public List getAsTimeDateList(String itemName, List defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a double
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a number
	 * @return double
	 */
	public Double getAsDouble(String itemName, Double defaultValue);
	
	/**
	 * Convenience function that converts a summary value to an integer
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a number
	 * @return integer
	 */
	public Integer getAsInteger(String itemName, Integer defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a double list
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a number
	 * @return double list
	 */
	public List getAsDoubleList(String itemName, List defaultValue);
	
	/**
	 * Convenience function that converts a summary value to an integer list
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a number
	 * @return integer list
	 */
	public List getAsIntegerList(String itemName, List defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a long value
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a number
	 * @return long
	 */
	public Long getAsLong(String itemName, Long defaultValue);
	
	/**
	 * Convenience function that converts a summary value to a list of long values
	 * 
	 * @param itemName item name, case insensitive
	 * @param defaultValue default value if column is empty or is not a number
	 * @return long list
	 */
	public List getAsLongList(String itemName, List defaultValue);
	
}