com.metamatrix.platform.admin.api
Interface PermissionNode

All Superinterfaces:

java.lang.Comparable, PropertiedObject, TreeNode

All Known Subinterfaces:

PermissionDataNode

All Known Implementing Classes:

PermissionDataNodeImpl

public interface PermissionNode
extends TreeNode

Method Summary

boolean	actionsAreEqual(AuthorizationActions actions) Determine if this node's AuthorizationActions are equal to the given actions.
boolean	actionsAreEqual(PermissionNode node) Determine if this node's AuthorizationActions are equal to the given node's actions.
boolean	actionsAreEqual(java.lang.String[] actions) Determine if this node's AuthorizationActions are equal to the given actions.
java.lang.String[]	getActionLabels() The AuthorizationActions labels currently on this data node.
AuthorizationActions	getActions() The AuthorizationActions currently on this data node.
AuthorizationActions	getAllowedActions() The AuthorizationActions allowed on this data node.
java.lang.String	getDisplayName() Display name for node.
java.lang.String	getResourceName() Resource name for node (the DataNodeFullName).
ObjectID	getUUID() The node's unique ID.
boolean	hasPermission() Does this node have any permission associated with it?
boolean	isHidden() Check whether or not this node is hidden from the PermissionDataNodeTreeView.
boolean	isLeafNode() Is this node a leaf?
void	setActions(AuthorizationActions actions) Set the AuthorizationActions on this data node.
void	setActions(int actions) Set the allowed AuthorizationActions on this data node.
void	setHidden(boolean isHidden) Set whether or not this node is hidden from the PermissionDataNodeTreeView.

Methods inherited from interface com.metamatrix.common.tree.TreeNode

compareTo, equals, exists, getFullName, getName, getNamespace, getSeparator, getSeparatorChar, getType, isModified, toString

Method Detail

getDisplayName

java.lang.String getDisplayName()

Display name for node.

Returns:

The name of the data node for display.

getResourceName

java.lang.String getResourceName()

Resource name for node (the DataNodeFullName).

Returns:

The resource name of the data node.

getUUID

ObjectID getUUID()

The node's unique ID.

Returns:

The unique ID for the node.

getActionLabels

java.lang.String[] getActionLabels()

The AuthorizationActions labels currently on this data node.

Returns:

The Array of one or more of {"None", "Create", "Read", "Update", "Delete"}.

See Also:

StandardAuthorizationActions

getActions

AuthorizationActions getActions()

The AuthorizationActions currently on this data node.

Returns:

The actions allowed on this data node.

See Also:

StandardAuthorizationActions

getAllowedActions

AuthorizationActions getAllowedActions()

The AuthorizationActions allowed on this data node.

Returns:

The actions allowed on this data node.

See Also:

StandardAuthorizationActions

setActions

void setActions(AuthorizationActions actions)
                throws PermissionNodeNotActionableException

Set the AuthorizationActions on this data node.

Parameters:

actions - The the actions to set on this data node.

Throws:

PermissionNodeNotActionableException - If attempt is made to set actions on a node that can't accept any actions.

setActions

void setActions(int actions)
                throws PermissionNodeNotActionableException

Set the allowed AuthorizationActions on this data node.

Parameters:

actions - The the actions to set on this data node.

Throws:

PermissionNodeNotActionableException - If attempt is made to set actions on a node that can't accept any actions.

actionsAreEqual

boolean actionsAreEqual(java.lang.String[] actions)

Determine if this node's AuthorizationActions are equal to the given actions. The actions are considered equal if number of actions are the same and all corresponding pairs of actions are equal.

Parameters:

actions - The Array of one or more of {"None", "Create", "Read", "Update", "Delete"}.

Returns:

true if the Actions of this node are equal to the given actions.

actionsAreEqual

boolean actionsAreEqual(AuthorizationActions actions)

Determine if this node's AuthorizationActions are equal to the given actions. The actions are considered equal if number of actions are the same and all corresponding pairs of actions are equal.

Parameters:

actions - The AuthorizationActions to compare with this node's actions.

Returns:

true if the Actions of this node are equal to the given actions.

actionsAreEqual

boolean actionsAreEqual(PermissionNode node)

Determine if this node's AuthorizationActions are equal to the given node's actions. The actions are considered equal if number of actions are the same and all corresponding pairs of actions are equal.

Parameters:

node - The node whose actions to compare with this node's actions.

Returns:

true if the Actions of this node are equal to the given node's actions.

isLeafNode

boolean isLeafNode()

Is this node a leaf?

Returns:

true, if this node has no children.

isHidden

boolean isHidden()

Check whether or not this node is hidden from the PermissionDataNodeTreeView. The default is false, the node is not hidden.

Returns:

true if this node may be hidden from the view.

See Also:

PermissionTreeView.setShowHidden(boolean)

setHidden

void setHidden(boolean isHidden)

Set whether or not this node is hidden from the PermissionDataNodeTreeView. The default is false, the node is not hidden.

Parameters:

isHidden - If true, this node may be hidden from the view.

See Also:

PermissionTreeView.setShowHidden(boolean)

hasPermission

boolean hasPermission()

Does this node have any permission associated with it?

Returns:

True, if this node has an Action other than NONE.