com.ibm.itim.fesiextensions

Class JSDirectoryObjectFactory

java.lang.Object

com.ibm.itim.fesiextensions.JSDirectoryObjectFactory

All Implemented Interfaces:

JSObjectFactory

Deprecated.

This class is part of the FESI script framework and will no longer be supported or updated as of ITIM 5.0. Use JSDirectoryObjectWrapperFactory instead.

public class JSDirectoryObjectFactory
extends java.lang.Object
implements JSObjectFactory

JSDirectoryObjectFactory provides an interface for creating JS objects that represent entities in the platform's data model, such as services, accounts, and people. Any extension that wishes to create and return entities to the javascript interpreter can use this object to ensure proper construction of the representing javascript objects. The JS Object created by this object will have the following profile:
Members:

• dn
• name

Functions:

• getPropertyNames
• getProperty
• getChanges
• setProperty
• removeProperty

See Also:

JSDirectoryObjectWrapperFactory

Field Summary

Fields inherited from interface com.ibm.itim.fesiextensions.JSObjectFactory

CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
JSDirectoryObjectFactory() Deprecated.

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	checkForJSDirectoryObject(java.lang.Object object) Deprecated. Check if given object is of DirectoryObjectWrapper type and return the wrapped DirectoryObjectEntity if it is.
static FESI.jslib.JSObject	createDirectoryObject(FESI.jslib.JSGlobalObject go, DirectoryObject directoryObject) Deprecated. Within the context of the global JS object, create a DirectoryObject JS object.
static FESI.jslib.JSObject	createDirectoryObject(FESI.jslib.JSGlobalObject go, DirectoryObjectEntity entity) Deprecated. Within the context of the global JS object, create a DirectoryObject JS object.
static FESI.jslib.JSObject	createDirectoryObject(FESI.jslib.JSGlobalObject go, FESI.jslib.JSObject parent, java.lang.String name, DirectoryObject directoryObject) Deprecated. Within the context of the global JS object, create a named DirectoryObject JS object.
static FESI.jslib.JSObject	createDirectoryObject(FESI.jslib.JSGlobalObject go, FESI.jslib.JSObject parent, java.lang.String name, DirectoryObjectEntity directoryObjectEntity) Deprecated. Within the context of the global JS object, create a named DirectoryObject JS object.
static com.ibm.itim.fesiextensions.wrapper.DirectoryObjectWrapper	createDirectoryObjectWrapper(DirectoryObject directoryObject) Deprecated. factory method for creating DirectoryObjectWrappers of the correct subclass This methods can be used by extensions that need to return directory object wrappers from extension methods.
static com.ibm.itim.fesiextensions.wrapper.DirectoryObjectWrapper	createDirectoryObjectWrapper(DirectoryObjectEntity directoryObjectEntity) Deprecated. factory method for creating DirectoryObjectWrappers of the correct subclass This method may be used by extensions that need to return directory object wrappers from extension methods.
java.lang.Object	createJavaObject(java.lang.String name, FESI.jslib.JSObject o) Deprecated. Creates a Java object from the specified JavaScript object.
FESI.jslib.JSObject	createScriptObject(FESI.jslib.JSGlobalObject go, FESI.jslib.JSObject parent, java.lang.String name, java.lang.Object item) Deprecated. Creates a named object that can be used in the client's script.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSDirectoryObjectFactory

public JSDirectoryObjectFactory()

Deprecated.

Method Detail

createScriptObject

public FESI.jslib.JSObject createScriptObject(FESI.jslib.JSGlobalObject go,
                                              FESI.jslib.JSObject parent,
                                              java.lang.String name,
                                              java.lang.Object item)
                                       throws FESI.jslib.JSException

Deprecated.

Creates a named object that can be used in the client's script. This method differes from setContextItem in that it will translate the given java object to an object that is compatible with the scripting language implementation and the result can be used in the client scripts, not just by the script engine extensions.

Specified by:

createScriptObject in interface JSObjectFactory

Parameters:

go - JSGlobalObject as calling context.

parent - JSObject to be registered as a member of. Same as go if global.

name - Name of the object in the scripting environment

item - Object that will be made available as a script object

Returns:

JSObject representing the given object.

Throws:

FESI.jslib.JSException - when the object can not be converted into a format that can be used within the script environment

createJavaObject

public java.lang.Object createJavaObject(java.lang.String name,
                                         FESI.jslib.JSObject o)
                                  throws FESI.jslib.JSException

Deprecated.

Creates a Java object from the specified JavaScript object. This conversion is not supported for DirectoryObjectEntities.

Specified by:

createJavaObject in interface JSObjectFactory

Parameters:

name - Name of the JavaScript object. Can be empty.

o - JSObject to convert from.

Returns:

Java object that represents the JSObject.

Throws:

FESI.jslib.JSException - if the specified JSObject is malformed or not compatible with this factory.

checkForJSDirectoryObject

public static java.lang.Object checkForJSDirectoryObject(java.lang.Object object)
                                                  throws FESI.jslib.JSException

Deprecated.

Check if given object is of DirectoryObjectWrapper type and return the wrapped DirectoryObjectEntity if it is. If object is not a DirectoryObjectWrapper, or the wrapped object is not a DirectoryObjectEntity then return object.

Parameters:

object - Object to check

Returns:

Object The wrapped DirectoryObjectEntity or the origional object.

Throws:

FESI.jslib.JSException - If anything goes wrong.

createDirectoryObject

public static FESI.jslib.JSObject createDirectoryObject(FESI.jslib.JSGlobalObject go,
                                                        FESI.jslib.JSObject parent,
                                                        java.lang.String name,
                                                        DirectoryObjectEntity directoryObjectEntity)
                                                 throws FESI.jslib.JSException

Deprecated.

Within the context of the global JS object, create a named DirectoryObject JS object.

Parameters:

go - JSGlobalObject as calling context.

parent - JSObject to be registered as a member of.

name - Name of the JS object in the script environment.

directoryObjectEntity - DirectoryObjectEntity that implements, or is represented by, the created JS object.

Returns:

JSObject representing the given entity.

Throws:

FESI.jslib.JSException

createDirectoryObject

public static FESI.jslib.JSObject createDirectoryObject(FESI.jslib.JSGlobalObject go,
                                                        FESI.jslib.JSObject parent,
                                                        java.lang.String name,
                                                        DirectoryObject directoryObject)
                                                 throws FESI.jslib.JSException

Deprecated.

Within the context of the global JS object, create a named DirectoryObject JS object.

Parameters:

go - JSGlobalObject as calling context.

parent - JSObject to be registered as a member of.

name - Name of the JS object in the script environment.

directoryObject - DirectoryObject that implements, or is represented by, the created JS object.

Returns:

JSObject representing the given entity.

Throws:

FESI.jslib.JSException

createDirectoryObject

public static FESI.jslib.JSObject createDirectoryObject(FESI.jslib.JSGlobalObject go,
                                                        DirectoryObjectEntity entity)
                                                 throws FESI.jslib.JSException

Deprecated.

Within the context of the global JS object, create a DirectoryObject JS object.

Parameters:

go - JSObject as calling context.

entity - DirectoryObjectEntity that implements, or is represented by, the created JS object.

Returns:

JSObject representing the given entity.

Throws:

FESI.jslib.JSException

createDirectoryObject

public static FESI.jslib.JSObject createDirectoryObject(FESI.jslib.JSGlobalObject go,
                                                        DirectoryObject directoryObject)
                                                 throws FESI.jslib.JSException

Deprecated.

Within the context of the global JS object, create a DirectoryObject JS object.

Parameters:

go - JSObject as calling context.

directoryObject - DirectoryObject that implements, or is represented by, the created JS object.

Returns:

JSObject representing the given entity.

Throws:

FESI.jslib.JSException

createDirectoryObjectWrapper

public static com.ibm.itim.fesiextensions.wrapper.DirectoryObjectWrapper createDirectoryObjectWrapper(DirectoryObjectEntity directoryObjectEntity)

Deprecated.

factory method for creating DirectoryObjectWrappers of the correct subclass This method may be used by extensions that need to return directory object wrappers from extension methods.

Parameters:

directoryObjectEntity - the dirObjectEntity to wrap

Returns:

a wrapped directory object of the appropriate subclass DirectoryObjectWrapper, AccountWrapper, PersonWrapper etc...

createDirectoryObjectWrapper

public static com.ibm.itim.fesiextensions.wrapper.DirectoryObjectWrapper createDirectoryObjectWrapper(DirectoryObject directoryObject)

Deprecated.

factory method for creating DirectoryObjectWrappers of the correct subclass This methods can be used by extensions that need to return directory object wrappers from extension methods.

Parameters:

directoryObject - the dirObject to wrap

Returns:

a wrapped directory object of the appropriate subclass DirectoryObjectWrapper, AccountWrapper, PersonWrapper etc...