org.jasig.portal.channels.jsp.tree
Interface ISurrogate

All Known Implementing Classes:

BaseSurrogateImpl, DefaultSurrogate

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface ISurrogate

Implementations of this class represent an object that knows how to acquire specific pieces of information needed to present a node in a hierarchical tree view.

Author:

Mark Boyd

Method Summary

boolean	canContainChildren(Object o) Deprecated.
boolean	canResolve(Object o) Deprecated. Determines if the passed in Object is an instance of an object for which this class can act as a surrogate.
Object[]	getAspects(Object o) Deprecated. Returns the aspects of the passed in object.
Object[]	getChildren(Object o) Deprecated.
String	getId(Object o) Deprecated. Gets the unique id for the passed in object.
Object	getLabelData(Object o) Deprecated. Returns information needed for rendering the UI representation of this node.
boolean	hasAspects(Object o) Deprecated. Indicates if this object has aspects.
boolean	hasChildren(Object o) Deprecated.

Method Detail

canResolve

boolean canResolve(Object o)

Deprecated.

Determines if the passed in Object is an instance of an object for which this class can act as a surrogate.

Parameters:

o -

Returns:

true if this class can act as a surrogate for the passed in object.

getId

String getId(Object o)

Deprecated.

Gets the unique id for the passed in object. This id will be used in as the value of query parameter, jsp_tree_item, in the event that this item supports any actions and the link for that action for thit item in the view was selected by a user. It also is the value passed to the label resolver to acquire the UI presentable label to represent the passed in object in the view.

Parameters:

o -

Returns:

the id for o.

getLabelData

Object getLabelData(Object o)

Deprecated.

Returns information needed for rendering the UI representation of this node. Since label rendering is pluggable the object returned should be known and understood by the plugged-in rendering JSP.

Parameters:

o -

Returns:

the UI presentable label for o.

hasAspects

boolean hasAspects(Object o)

Deprecated.

Indicates if this object has aspects. Aspects act like children but do not include a line from them to the parent-to-child branch and can be exposed without expanding the parent to show the children. Unlike children, aspects can not have any contained nodes. They are only meant to portray some information of the parent node.

Parameters:

o -

Returns:

getAspects

Object[] getAspects(Object o)

Deprecated.

Returns the aspects of the passed in object. This method is only called hasAspects() returns true. Aspects act like children but do not include a line from them to the parent-to-child branch and can be exposed without expanding the parent to show the children. Unlike children, aspects can not have any containing nodes. They are only meant to portray some information of the parent node.

Parameters:

o -

Returns:

canContainChildren

boolean canContainChildren(Object o)

Deprecated.

hasChildren

boolean hasChildren(Object o)

Deprecated.

getChildren

Object[] getChildren(Object o)

Deprecated.