com.sap.portal.unification.hrnpnode

Interface IHRNPNodeFactoryService

All Superinterfaces:

IService

public interface IHRNPNodeFactoryService

extends IService

A service that manages HRNP nodes.
The service can be used to create new nodes.
Methods deal only with returning new nodes to the user.

Field Summary

static String

KEY Service key.

Method Summary

IHRNPDestination	createHRNPDestination() Creates a new IHRNPDestination node.
IHRNPDestination	createHRNPDestination(String str) Creates a new IHRNPDestination based on a HRNP string.
IHRNPDestination	createHRNPDestination(String componentType, String iview) Creates a new IHRNPDestination based on parameters.
IHRNPDestination	createHRNPDestination50() Creates a new IHRNPDestination50 node.
IHRNPMultiOp	createHRNPMultiOp(String str) Creates a new IHRNPMultiOp based on a HRNP string.
IHRNPOperatorNode	createHRNPOperatorNode() Creates a new operator node.
IHRNPOperatorNode	createHRNPOperatorNode(String operator, IHRNPNode left, IHRNPNode right) Creates a new operator node node based on parameters.
IHRNPOperatorNode	createHRNPOperatorNode(String operator, IHRNPNode left, IHRNPNode right, String relation) Creates a new operator node node based on parameters.
IHRNPSource	createHRNPSource() Creates a new IHRNPSource node.
IHRNPSource	createHRNPSource(String str) Creates a new IHRNPSource based on a HRNP string.
IHRNPSource	createHRNPSource(String systemAlias, String object, String attribute, String value) Creates a new IHRNPSource based on parameters.
IHRNPSource50	createHRNPSource50() Creates a new IHRNPSource50 node.
IHRNPSource50	createHRNPSource50(String str) Creates a new IHRNPSource50 based on a HRNP string.
IHRNPSource50	createHRNPSource50(String server, int port, String table, String attrib, String value) Creates a new IHRNPSource50 based on parameters.

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

public static final String KEY

Service key.

See Also:

Constant Field Values

Method Detail

createHRNPOperatorNode

public IHRNPOperatorNode createHRNPOperatorNode()

Creates a new operator node.

Returns:

new instance of operator node.

createHRNPOperatorNode

public IHRNPOperatorNode createHRNPOperatorNode(String operator,
                                                IHRNPNode left,
                                                IHRNPNode right)

Creates a new operator node node based on parameters.

Parameters:

operator - operator of kind IHRNPNode.OPERATOR_DRAG_AND_RELATE or IHRNPNode.OPERATOR_FILTER or IHRNPNode.OPERATOR_OR.

left - left leaf of the operator node.

right - right leaf of the operator node.

Returns:

new instance of operator node.

createHRNPOperatorNode

public IHRNPOperatorNode createHRNPOperatorNode(String operator,
                                                IHRNPNode left,
                                                IHRNPNode right,
                                                String relation)

Creates a new operator node node based on parameters.

Parameters:

operator - operator of kind IHRNPNode.OPERATOR_DRAG_AND_RELATE or IHRNPNode.OPERATOR_FILTER or IHRNPNode.OPERATOR_OR.

left - left leaf of the operator node.

right - right leaf of the operator node.

relation - relation name of the relation that has been chosen for this drag and relate operation.

Returns:

new instance of operator node.

createHRNPSource50

public IHRNPSource50 createHRNPSource50()

Creates a new IHRNPSource50 node.
IHRNPSource50 is used for Unifier 5.0 in NW EP 6.0 only. For NW EP 6.0 use IHRNPSource.

Returns:

new instance of IHRNPSource50.

createHRNPSource50

public IHRNPSource50 createHRNPSource50(String server,
                                        int port,
                                        String table,
                                        String attrib,
                                        String value)

Creates a new IHRNPSource50 based on parameters.
IHRNPSource50 is used for Unifier 5.0 in NW EP 6.0 only.

Parameters:

server - domain name or IP of the portal.

port - port of the portal.

table - table from which to retrieve a value.

attrib - column in a table from which to retrieve a value.

value - in the column of the table.

Returns:

new instance of IHRNPSource50.

createHRNPSource50

public IHRNPSource50 createHRNPSource50(String str)
                                 throws HRNPSource50FormatException

Creates a new IHRNPSource50 based on a HRNP string.
IHRNPSource50 is used for Unifier 5.0 in NW EP 6.0 only.

Parameters:

str - HRNP string represanting the IHRNPSource50. Format of the string is: "server:port/set:table/attrib/value" .

Returns:

new instance of IHRNPSource50.

Throws:

{@link - HRNPSource50FormatException} if the string is not in the valid IHRNPSource50 format.

HRNPSource50FormatException

createHRNPDestination50

public IHRNPDestination createHRNPDestination50()

Creates a new IHRNPDestination50 node.
IHRNPDestination50 is used for Unifier 5.0 in NW EP 6.0 only.

Returns:

new instance of HRNPDestination.

createHRNPDestination

public IHRNPDestination createHRNPDestination()

Creates a new IHRNPDestination node.

Returns:

new instance of IHRNPDestination.

createHRNPDestination

public IHRNPDestination createHRNPDestination(String componentType,
                                              String iview)

Creates a new IHRNPDestination based on parameters.

Parameters:

componentType - one of the following constants represanting component type:
IHRNPDestination.COMPONENT_ACTION, IHRNPDestination.COMPONENT_FOLDER, IHRNPDestination.COMPONENT_REPORT, or IHRNPDestination.COMPONENT_SYSTEM.

iview - full pcd path to destination iview.

Returns:

new instance of IHRNPDestination.

createHRNPDestination

public IHRNPDestination createHRNPDestination(String str)
                                       throws HRNPDestinationFormatException

Creates a new IHRNPDestination based on a HRNP string.

Parameters:

str - HRNP string represanting the IHRNPDestination. Format of the string is: "server:port/component_type/iview"

Returns:

new instance of HRNPDestination.

Throws:

{@link - com.sap.portal.unification.hrnpexception.HRNPDestinationFormatException HRNPDestinationFormatException} if the str is not in the valid IHRNPDestination format.

HRNPDestinationFormatException

createHRNPSource

public IHRNPSource createHRNPSource()

Creates a new IHRNPSource node.

Returns:

new instance of IHRNPSource.

createHRNPSource

public IHRNPSource createHRNPSource(String systemAlias,
                                    String object,
                                    String attribute,
                                    String value)

Creates a new IHRNPSource based on parameters.

Parameters:

systemAlias - system alias of the system in the system landscape.

object - business object name or table name of source object.

attribute - column in a table from which to retrieve a value or an attribute of the business object.

value - in the column of the table.

Returns:

new instance of IHRNPSource.

createHRNPSource

public IHRNPSource createHRNPSource(String str)
                             throws HRNPSourceFormatException

Creates a new IHRNPSource based on a HRNP string.

Parameters:

str - HRNP string represanting the IHRNPSource.
str format is: "server:port/system/object/attrib/value". Server:port can be 0:0.

Returns:

new instance of IHRNPSource.

Throws:

{@link - HRNPSourceFormatException} if the str is not in the valid IHRNPSource format.

HRNPSourceFormatException

createHRNPMultiOp

public IHRNPMultiOp createHRNPMultiOp(String str)
                               throws HRNPMultiOpFormatException,
                                      HRNPNoOperatorFoundException,
                                      HRNPSource50FormatException

Creates a new IHRNPMultiOp based on a HRNP string.

Parameters:

str - HRNP string represantation of multiop operator.

Returns:

new instance of IHRNPMultiOp.

Throws:

{@link - HRNPMultiOpFormatException}, HRNPNoOperatorFoundException, HRNPSource50FormatException.

HRNPMultiOpFormatException

HRNPNoOperatorFoundException

HRNPSource50FormatException