Package hudson.model

Class AbstractModelObject

java.lang.Object

hudson.model.AbstractModelObject

All Implemented Interfaces:

ModelObject, SearchableModelObject, SearchItem

Direct Known Subclasses:

Actionable, AdministrativeMonitor, Api, CloudSet, ComputerSet, HudsonHomeDiskUsageMonitor.Solution, LogRecorder, LogRecorderManager, Node, PluginManager, TaskAction, UpdateCenter, User, View

public abstract class AbstractModelObject
extends Object
implements SearchableModelObject

ModelObject with some convenience methods.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor	Description
AbstractModelObject()

Method Summary

Modifier and Type	Method	Description
Search	getSearch()	This binds Search object to the URL hierarchy.
final SearchIndex	getSearchIndex()	Returns the SearchIndex to further search sub items inside this item.
String	getSearchName()	Default implementation that returns the display name.
protected SearchIndexBuilder	makeSearchIndex()	Default implementation that returns empty index.
protected final void	requirePOST()	Deprecated. Use RequirePOST on your method.
protected final void	sendError(Exception e)
protected final void	sendError(Exception e, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Displays the error in a page.
protected final void	sendError(Exception e, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use sendError(Exception, StaplerRequest2, StaplerResponse2)
protected final void	sendError(String message)
protected final void	sendError(String message, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
protected final void	sendError(String message, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, boolean pre)
protected final void	sendError(String message, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use sendError(String, StaplerRequest2, StaplerResponse2)
protected final void	sendError(String message, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, boolean pre)	Deprecated. use sendError(String, StaplerRequest2, StaplerResponse2, boolean)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Methods inherited from interface hudson.search.SearchItem

getSearchIcon, getSearchUrl

Constructor Details

AbstractModelObject

public AbstractModelObject()

Method Details

sendError

protected final void sendError(Exception e,
 org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                        throws jakarta.servlet.ServletException,
IOException

Displays the error in a page.

Throws:

jakarta.servlet.ServletException

IOException

sendError

@Deprecated
protected final void sendError(Exception e,
 org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
                        throws javax.servlet.ServletException,
IOException

Deprecated.

use sendError(Exception, StaplerRequest2, StaplerResponse2)

Throws:

javax.servlet.ServletException

IOException

sendError

protected final void sendError(Exception e)
                        throws jakarta.servlet.ServletException,
IOException

Throws:

jakarta.servlet.ServletException

IOException

sendError

protected final void sendError(String message,
 org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                        throws jakarta.servlet.ServletException,
IOException

Throws:

jakarta.servlet.ServletException

IOException

sendError

@Deprecated
protected final void sendError(String message,
 org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
                        throws javax.servlet.ServletException,
IOException

Deprecated.

use sendError(String, StaplerRequest2, StaplerResponse2)

Throws:

javax.servlet.ServletException

IOException

sendError

protected final void sendError(String message,
 org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 boolean pre)
                        throws jakarta.servlet.ServletException,
IOException

Parameters:

pre - If true, the message is put in a PRE tag.

Throws:

jakarta.servlet.ServletException

IOException

sendError

@Deprecated
protected final void sendError(String message,
 org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp,
 boolean pre)
                        throws javax.servlet.ServletException,
IOException

Deprecated.

use sendError(String, StaplerRequest2, StaplerResponse2, boolean)

Throws:

javax.servlet.ServletException

IOException

sendError

protected final void sendError(String message)
                        throws jakarta.servlet.ServletException,
IOException

Throws:

jakarta.servlet.ServletException

IOException

requirePOST

@Deprecated
protected final void requirePOST()
                          throws jakarta.servlet.ServletException

Deprecated.

Use RequirePOST on your method.

Convenience method to verify that the current request is a POST request.

Throws:

jakarta.servlet.ServletException

makeSearchIndex

protected SearchIndexBuilder makeSearchIndex()

Default implementation that returns empty index.

getSearchIndex

public final SearchIndex getSearchIndex()

Description copied from interface: SearchItem

Returns the SearchIndex to further search sub items inside this item.

Specified by:

getSearchIndex in interface SearchItem

Returns:

SearchIndex.EMPTY if this is a leaf.

See Also:

• SearchIndexBuilder

getSearch

public Search getSearch()

Description copied from interface: SearchableModelObject

This binds Search object to the URL hierarchy.

Specified by:

getSearch in interface SearchableModelObject

getSearchName

public String getSearchName()

Default implementation that returns the display name.

Specified by:

getSearchName in interface SearchItem