IOpenShiftResource.java

package com.openshift.client;


public interface IOpenShiftResource {

	/**
	 * Returns
	 * <code>true</true> if there is log about the creation of this resource. 
	 * Creation logs are only available at creation time. So resources that were retrieved 
	 * while they already existed wont have a creation log.
	 * 
	 * @return true if there's creation log for this resource
	 */
	public boolean hasCreationLog();

	/**
	 * Returns the log that was created when the resource was created.
	 * 
	 * @return the log which reported the creation of this resource
	 */
	public String getCreationLog();

	/**
	 * Returns all the (creation log) messages. These messages only exist at
	 * creation time. Existing cartridges, that were added in a prior session
	 * don't have any messages any more.
	 * 
	 * @return all messages by field
	 * 
	 * @see #getCreationLog()
	 */
	public Messages getMessages();

	/**
	 * Refresh the resource and its list of children resources that were
	 * previously loaded
	 * 
	 * @throws OpenShiftException
	 */
	public void refresh() throws OpenShiftException;

}