com.sap.portal.genericcreator

Class GenericCreatorParams

java.lang.Object

com.sap.portal.genericcreator.GenericCreatorParams

public class GenericCreatorParams
extends Object

The class that holds the parameters that the IGenericCreator class needs to execute a script - the current user and the script.

Constructor Summary

Constructors

Constructor and Description
GenericCreatorParams(com.sap.security.api.IUser user, InputStream XMLDocument) A constructor that specifies the user and the XML script to execute.
GenericCreatorParams(com.sap.security.api.IUser user, String XMLDocumentAsString) A constructor that specifies the user and the XML script to execute.
GenericCreatorParams(String userID, InputStream XMLDocument) A constructor that specifies the user and the XML script to execute.
GenericCreatorParams(String userID, String XMLDocumentAsString) A constructor that specifies the user and the XML script to execute.

Method Summary

Modifier and Type	Method and Description
com.sap.security.api.IUser	getSpecifiedUser() Gets the user specified for executing the script.
com.sap.security.api.IUser	getUser() Deprecated. Replaced by getSpecifiedUser()
InputStream	getXMLDocument() Deprecated. Replaced by getXMLScript()
InputStream	getXMLScript() Gets the XML script to execute.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericCreatorParams

public GenericCreatorParams(com.sap.security.api.IUser user,
                            InputStream XMLDocument)

A constructor that specifies the user and the XML script to execute.

Parameters:

user - the user executing the script

XMLDocument - the XML script as an InputStream

GenericCreatorParams

public GenericCreatorParams(com.sap.security.api.IUser user,
                            String XMLDocumentAsString)

A constructor that specifies the user and the XML script to execute.

Parameters:

user - the user executing the script

XMLDocumentAsString - the XML script as a String

GenericCreatorParams

public GenericCreatorParams(String userID,
                            InputStream XMLDocument)

A constructor that specifies the user and the XML script to execute.

Parameters:

userID - the uniqueID or the logonID of the user executing the script

XMLDocument - the XML script as an InputStream

GenericCreatorParams

public GenericCreatorParams(String userID,
                            String XMLDocumentAsString)

A constructor that specifies the user and the XML script to execute.

Parameters:

userID - the uniqueID or the logonID of the user executing the script

XMLDocumentAsString - the XML script as a String

Method Detail

getUser

public com.sap.security.api.IUser getUser()
                                   throws com.sap.security.api.UMException

Deprecated. Replaced by getSpecifiedUser()

Gets the user specified for executing the script.

Returns:

the user executing the script

Throws:

com.sap.security.api.UMException - This exception is never thrown.

getXMLDocument

public InputStream getXMLDocument()
                           throws UnsupportedEncodingException

Deprecated. Replaced by getXMLScript()

Gets the XML script to execute.

Returns:

the XML script as an InputStream

Throws:

UnsupportedEncodingException - This exception is never thrown.

getSpecifiedUser

public com.sap.security.api.IUser getSpecifiedUser()

Gets the user specified for executing the script.

Returns:

the user executing the script

getXMLScript

public InputStream getXMLScript()

Gets the XML script to execute.

Returns:

the XML script as an InputStream