Package org.apache.wiki.ui

Class GroupCommand

java.lang.Object

org.apache.wiki.ui.AbstractCommand

org.apache.wiki.ui.GroupCommand

All Implemented Interfaces:

org.apache.wiki.api.core.Command

public final class GroupCommand
extends AbstractCommand

Defines Commands for viewing, editing and deleting wiki groups. GroupCommands can be combined with GroupPrincipals to produce targeted Commands.

This class is not final; it may be extended in the future.

Since:

2.4.22

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.wiki.api.core.Command	DELETE_GROUP	GroupCommand for deleting a group.
static final org.apache.wiki.api.core.Command	EDIT_GROUP	GroupCommand for editing a group.
static final org.apache.wiki.api.core.Command	VIEW_GROUP	GroupCommand for viewing a group.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the command, which will either be the target (if specified), or the "friendly name" for the JSP.
Permission	requiredPermission()	Returns the permission required to execute this GroupCommand.
org.apache.wiki.api.core.Command	targetedCommand(Object target)	Creates and returns a targeted Command by combining a GroupPrincipal with this Command.

Methods inherited from class org.apache.wiki.ui.AbstractCommand

getContentTemplate, getJSP, getJSPFriendlyName, getRequestContext, getTarget, getURLPattern, toString

Methods inherited from class java.lang.Object

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

Field Details

DELETE_GROUP

public static final org.apache.wiki.api.core.Command DELETE_GROUP

GroupCommand for deleting a group.

EDIT_GROUP

public static final org.apache.wiki.api.core.Command EDIT_GROUP

GroupCommand for editing a group.

VIEW_GROUP

public static final org.apache.wiki.api.core.Command VIEW_GROUP

GroupCommand for viewing a group.

Method Details

targetedCommand

public org.apache.wiki.api.core.Command targetedCommand(Object target)

Creates and returns a targeted Command by combining a GroupPrincipal with this Command. The supplied target object must be non-null and of type GroupPrincipal. If the target is not of the correct type, this method throws an IllegalArgumentException.

Specified by:

targetedCommand in interface org.apache.wiki.api.core.Command

Specified by:

targetedCommand in class AbstractCommand

Parameters:

target - the GroupPrincipal to combine into the current Command

Returns:

the new, targeted command

See Also:

• Command.targetedCommand(Object)

getName

public String getName()

Returns the name of the command, which will either be the target (if specified), or the "friendly name" for the JSP.

Specified by:

getName in interface org.apache.wiki.api.core.Command

Specified by:

getName in class AbstractCommand

Returns:

the name

See Also:

• Command.getName()

requiredPermission

public Permission requiredPermission()

Returns the permission required to execute this GroupCommand.

Returns:

the permission

See Also:

• Command.requiredPermission()