com.netegrity.llsdk6.imsapi.managedobject
Interface Task

All Superinterfaces:

AttributeCollection, ManagedObject, java.util.Map, ModifiableObject, NamedObject, java.io.Serializable

All Known Subinterfaces:

AccessTask, AdminTask

public interface Task
extends ManagedObject

Provides access to the attributes in a Task managed object through the methods inherited from the base interfaces.

This interface represents an administrative function or a business function. The managed object interfaces AdminTask and AccessTask extend the Task interface.

Since:

IdentityMinder 5.6

Nested Class Summary

static class

Task.FieldId Contains identifiers for the reserved fields on an access/admin task configuration screen.

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	APPLICATION The task object's associated application.
static java.lang.String	AUDITABLE Attribute identifier for the task object's auditable flag.
static java.lang.String	CATEGORY The task object's category value.
static java.lang.String	DESCRIPTION The task object's description.
static java.lang.String	EXTERNAL The task object's external task flag.
static java.lang.String	FRIENDLY_NAME The task object's friendly name.
static java.lang.String	METHOD_ID The ID of the method associated with the task object.
static java.lang.String	PROVISIONABLE The task object's provisionable flag.
static java.lang.String	SYSTEM The task object's system flag -- reserved for future use.
static java.lang.String	URL The task object's external task URL.
static java.lang.String	VERSION The task object's version.
static java.lang.String	WEBSERVICE The task object's Task Execution Web Service (TEWS) flag.
static java.lang.String	WORKFLOW_ID The task object's workflow ID -- for example, CreateUserApproveProcess.
static java.lang.String	WORKFLOWABLE The task object's workflow flag.

Method Summary

boolean	checkScopeOnModify() Determines whether the system will enforce a subject security check at the end of the task to determine if the subject is still in scope with the modified attributes, etc.
void	clearTabs() Removes all tabs from this task.
void	clearTaskHandlerDefinitions() Deletes all definitions -- typically used by Identity Manager.
Tab	createTab(java.lang.String tag, java.lang.String tabID, int order) Adds a new tab for this task.
TaskHandlerDefinition	createTaskHandlerDefinition(java.lang.String uniqueName, java.lang.String desc, java.lang.String classname, AttributeValidationRuleType scriptType, java.lang.String script, int executionOrder, java.util.Hashtable userprops) Creates a task handler definition -- typically used by Identity Manager.
ActionType	getActionType() Retrieves the basic action type (such as Create, Delete, Modify) associated with this task.
java.lang.String	getApplication() Retrieves the unique identifier of the application associated with this task.
AutoSynchType	getAutoAccountSynch() Determines whether automatic synchronization between the user's provisioning roles in the eTrust Admin directory and the associated role definitions in the Identity Manager environment is enabled, and if so, when synchronization occurs.
AutoSynchType	getAutoSynch() Determines whether the task triggers automatic firing of a user synchronization event when this task leaves the pending state.
int	getCategory2Order() Returns the Level 2 category Order for the task
int	getCategory3Order() Returns the Level 3 category Order for the task
int	getCategoryOrder() Returns the Category Order
PropertyDict	getConfigPropertyDict() Get configuration property dictionary To set the configuration property dictionary back use setLinkedDataDict
ObjectType	getPrimaryObjectType() Retrieves the object type (such as Admin Task, Access Role) associated with this task.
Screen	getPrimarySearchScreen() Retrieves the Screen definition for the primary object search screen associated with this task -- typically used by Identity Manager.
int	getPriority() Returns the priority for the task
java.lang.String	getReservedField(Task.FieldId id) Retrieves the value of a reserved field.
ScopeSecurityType	getScopeSecurityType() Alters the scope security type (such as AllObjectsInScope, AllObjects, GroupsAdminOf, ...) associated with this task.
Tab	getTab(java.lang.String tab) Retrieves the specified tab.
PropertyDict	getTabControllerConfig() Returns the tab controller configuration dictionary
java.lang.String	getTabControllerTag() Returns the tab controller for this task
java.util.Vector	getTabs() Retrieves all the tabs for this task.
java.util.Vector	getTabs(TabDefinition type) Retrieves all the tabs of the specified TabDefinition.
java.lang.String	getTaskCategory() Retrieves the category of this task.
java.lang.String	getTaskCategory2() Find out the Level 2 category of the Task associated with this TaskDefinition.
java.lang.String	getTaskCategory3() Find out the Level 3 category of the Task associated with this TaskDefinition.
java.lang.String	getTaskDescription() Retrieves the description of this task.
TaskHandlerDefinition	getTaskHandlerDefinition(java.lang.String uniqueName) Retrieves the specified TaskHandlerDefinition -- typically used by Identity Manager.
java.util.Vector	getTaskHandlerDefinitions() Retrieves all task handler definitions -- typically used by Identity Manager.
int	getTaskOrder() Return the task order associated with this Task.
java.lang.String	getTaskTag() Retrieves the tag associated with this task.
java.lang.String	getURL() Retrieves the external reference (typically a URL) where this task should be sent.
java.lang.String	getWorkflowProcess() Retrieves the workflow process name associated with the task.
boolean	isAuditable() Determines whether the task triggers the auditing feature.
boolean	isAutomaticExecution() Returns the the flag for the automatic execution of the task
boolean	isExternal() Determines whether this task is an external task.
boolean	isHidden() Determines whether this task is a hidden task.
boolean	isProvisionable() Determines whether the task triggers the provisioning feature (if the provisioning software is configured for your site).
boolean	isPublic() Determines whether this task is a public task.
boolean	isSystemTask() Determines whether this task is a system task.
boolean	isWebserviceTask() Determines whether the task is subject to Web Wervice requests.
boolean	isWorkflowTask() Determines whether the task triggers the workflow feature.
void	setActionType(ActionType at) Alters the action type (such as Create, Delete, Modify) associated with this task.
void	setApplication(java.lang.String application) Sets the unique identifier of the application associated with this task.
void	setAuditable(boolean system) Alters the auditing flag for the task.
void	setAutoAccountSynch(AutoSynchType synch) Alters the automatic synchronization flag for the user's eTrust Admin provisioning accounts.
void	setAutomaticExecution(boolean autoexec) Sets the flag for automatic execution of the task
void	setAutoSynch(AutoSynchType synch) Alters the synchronization flag for the task.
void	setCategory2Order(int categoryOrder) Sets the Level 2 category order for the task
void	setCategory3Order(int categoryOrder) Sets the Level 3 category order for the task
void	setCategoryOrder(int categoryOrder) Sets the Category order for the task
void	setCheckScopeOnModify(boolean checkScope) Alters the scope check flag for this task.
void	setExternal(boolean external) Specifies whether the task is an external task.
void	setFriendlyName(java.lang.String friendlyName) Sets the task's friendly name value.
void	setHidden(boolean hidden) Specifies whether the task is a hidden task.
void	setPrimaryObjectType(ObjectType type) Alters the object type (such as Admin Task, Access Role) associated with this task.
void	setPrimarySearchScreen(Screen searchScreen) Associates a Screen definition with this task as the primary object search screen for the task -- typically used by Identity Manager.
void	setPriority(int priority) Sets the priority for the task
void	setProvisionable(boolean pro) Alters the provisioning flag for the task.
void	setPublic(boolean publicFlag) Specifies whether the task is a public task.
void	setReservedField(Task.FieldId id, java.lang.String value) Sets the value of the specified reserved field, overwriting any existing value.
void	setScopeSecurityType(ScopeSecurityType sst) Alters the scope security type (such as AllObjectsInScope, AllObjects, GroupsAdminOf, ...) associated with this task.
void	setSystemTask(boolean system) Specifies whether the task is a system task.
void	setTabControllerConfig(PropertyDict tabControllerConfig) Sets the tab controller confiuration for this task
void	setTabControllerTag(java.lang.String tabControllerTag) Sets the tab controller for this task
void	setTaskCategory(java.lang.String newCategory) Sets the category of this task.
void	setTaskCategory2(java.lang.String newCategory2) Set the level2 category of the Task associated with this TaskDefinition
void	setTaskCategory3(java.lang.String newCategory3) Set the level 3 category of the Task associated with this TaskDefinition
void	setTaskDescription(java.lang.String newDescription) Sets the description of this task.
void	setTaskOrder(int taskOrder) Alter the task order associated with this Task.
void	setTaskTag(java.lang.String tag) Alters the tag for this task.
void	setURL(java.lang.String url) Sets the external reference (typically a URL) for this task.
void	setWebserviceTask(boolean isWebservice) Alters the Task Execution Web Service (TEWS) flag for the task.
void	setWorkflowTaskFlag(boolean wf) Alters the workflow flag for the task.

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.ManagedObject

directAddAttributeValue, directRemoveAttributeValue, equals, fixUniqueNames, getImsDirectory, getImsEnvironment, getObjectType, getOrg, getOrg, getProvider, hashCode, move, persisted

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

FRIENDLY_NAME

static final java.lang.String FRIENDLY_NAME

The task object's friendly name.

DESCRIPTION

static final java.lang.String DESCRIPTION

The task object's description.

SYSTEM

static final java.lang.String SYSTEM

The task object's system flag -- reserved for future use.

METHOD_ID

static final java.lang.String METHOD_ID

The ID of the method associated with the task object.

CATEGORY

static final java.lang.String CATEGORY

The task object's category value.

WORKFLOW_ID

static final java.lang.String WORKFLOW_ID

The task object's workflow ID -- for example, CreateUserApproveProcess.

VERSION

static final java.lang.String VERSION

The task object's version.

APPLICATION

static final java.lang.String APPLICATION

The task object's associated application.

URL

static final java.lang.String URL

The task object's external task URL.

EXTERNAL

static final java.lang.String EXTERNAL

The task object's external task flag.

AUDITABLE

static final java.lang.String AUDITABLE

Attribute identifier for the task object's auditable flag.

PROVISIONABLE

static final java.lang.String PROVISIONABLE

The task object's provisionable flag.

WORKFLOWABLE

static final java.lang.String WORKFLOWABLE

The task object's workflow flag.

WEBSERVICE

static final java.lang.String WEBSERVICE

The task object's Task Execution Web Service (TEWS) flag.

Method Detail

setFriendlyName

void setFriendlyName(java.lang.String friendlyName)

Sets the task's friendly name value. Note: To persist the change, call modifyObject().

Parameters:

friendlyName - The friendly name to set.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

getTaskDescription

java.lang.String getTaskDescription()

Retrieves the description of this task.

Returns:

The task description.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

setTaskDescription

void setTaskDescription(java.lang.String newDescription)

Sets the description of this task.

Parameters:

newDescription - The new task description.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

isSystemTask

boolean isSystemTask()

Determines whether this task is a system task. You cannot delete a system task.

Returns:

true if the task is a system task, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

setSystemTask

void setSystemTask(boolean system)

Specifies whether the task is a system task. A system task cannot be deleted.

Parameters:

system - true if the task is a system task, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

getTaskCategory

java.lang.String getTaskCategory()

Retrieves the category of this task.

Returns:

The task category.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

See Also:

setTaskCategory(String)

setTaskCategory

void setTaskCategory(java.lang.String newCategory)

Sets the category of this task.

In the Identity Manager user interface, tasks are grouped according to task category. The category name is displayed above the group. For example, the tasks Create User, Delete User, and Modify User might be grouped under the category User Management.

Parameters:

newCategory - A unique identifier for the new category.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

getApplication

java.lang.String getApplication()

Retrieves the unique identifier of the application associated with this task.

Returns:

The application identifier.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

setApplication

void setApplication(java.lang.String application)

Sets the unique identifier of the application associated with this task.

Parameters:

application - Unique identifier for the associated application.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

getWorkflowProcess

java.lang.String getWorkflowProcess()

Retrieves the workflow process name associated with the task.

Returns:

A String indicating the associated workflow process ID.

Throws:

DeletedObjectException - - If this object represents a Task that has already been deleted

AttributeNotPresentException - - If this Task was created without requesting the Task.WORKFLOW_ID attribute.

isProvisionable

boolean isProvisionable()

Determines whether the task triggers the provisioning feature (if the provisioning software is configured for your site).

Returns:

true if provisioning is enabled for the task, or false otherwise.

Throws:

DeletedObjectException

setProvisionable

void setProvisionable(boolean pro)

Alters the provisioning flag for the task.

Parameters:

pro - true to enable provisioning for the task, or false to disable it.

Throws:

DeletedObjectException

isAuditable

boolean isAuditable()

Determines whether the task triggers the auditing feature.

Returns:

true if auditing is enabled for the task, or false otherwise.

Throws:

DeletedObjectException

setAuditable

void setAuditable(boolean system)

Alters the auditing flag for the task.

Parameters:

system - true to enable auditing for the task, or false to disable it.

Throws:

DeletedObjectException

isWorkflowTask

boolean isWorkflowTask()

Determines whether the task triggers the workflow feature. If workflow is enabled for the task, the events in the task can be subject to workflow approval.

Returns:

true if workflow is enabled for the task, or false otherwise.

Throws:

DeletedObjectException

setWorkflowTaskFlag

void setWorkflowTaskFlag(boolean wf)

Alters the workflow flag for the task.

Parameters:

wf - true to enable workflow for the task, or false to disable it.

Throws:

DeletedObjectException

isWebserviceTask

boolean isWebserviceTask()

Determines whether the task is subject to Web Wervice requests. A Web Service request is issued to Identity Manager by a remote, third-party application. The request is issued through the Identity Manager Task Execution Web Service (TEWS) and executed by Identity Manager.

Returns:

true if TEWS is enabled for the task, or false otherwise.

Throws:

DeletedObjectException

setWebserviceTask

void setWebserviceTask(boolean isWebservice)

Alters the Task Execution Web Service (TEWS) flag for the task. If TEWS is enabled, the task can be submitted by a remote, third-party application and executed by Identity Manager.

Parameters:

isWebservice - true to enable TEWS for the task, or false to disable it.

Throws:

DeletedObjectException

getURL

java.lang.String getURL()

Retrieves the external reference (typically a URL) where this task should be sent. An external reference is used with an external task. Identity Manager issues external task requests to a remote, third party application for processing.

Returns:

The external reference for this task, or null.

Throws:

DeletedObjectException

setURL

void setURL(java.lang.String url)

Sets the external reference (typically a URL) for this task. An external reference is used with an external task. Identity Manager issues external task requests to a remote, third party application for processing.

Parameters:

url - The external reference for this task.

Throws:

DeletedObjectException

getTaskTag

java.lang.String getTaskTag()

Retrieves the tag associated with this task.

Returns:

The task tag.

setTaskTag

void setTaskTag(java.lang.String tag)

Alters the tag for this task.

Parameters:

tag - The new tag value

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

isExternal

boolean isExternal()

Determines whether this task is an external task. External tasks are executed by third-party applications.

Returns:

true if the task is an external task, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

setExternal

void setExternal(boolean external)

Specifies whether the task is an external task.

Parameters:

external - The new state of the external task flag.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

isHidden

boolean isHidden()

Determines whether this task is a hidden task. Hidden tasks do not appear in the Identity Manager User Console.

Returns:

true if the task is a hidden task, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

setHidden

void setHidden(boolean hidden)

Specifies whether the task is a hidden task.

Parameters:

hidden - The new state of the hidden task flag

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

isPublic

boolean isPublic()

Determines whether this task is a public task. Public tasks can be accessed through the public alias.

Returns:

true if the task is a public task, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

setPublic

void setPublic(boolean publicFlag)

Specifies whether the task is a public task. Tasks with this flag set can be accessed through the public alias.

Parameters:

publicFlag - The new state of the public task flag.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

checkScopeOnModify

boolean checkScopeOnModify()

Determines whether the system will enforce a subject security check at the end of the task to determine if the subject is still in scope with the modified attributes, etc.

Returns:

true or false depending on whether the flag is set.

setCheckScopeOnModify

void setCheckScopeOnModify(boolean checkScope)

Alters the scope check flag for this task.

Parameters:

checkScope - The new state of the scope check flag.

getActionType

ActionType getActionType()

Retrieves the basic action type (such as Create, Delete, Modify) associated with this task.

Returns:

The basic action type of the task. This method must not return null.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

setActionType

void setActionType(ActionType at)

Alters the action type (such as Create, Delete, Modify) associated with this task.

Parameters:

at - The action type to assign to the task.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

getScopeSecurityType

ScopeSecurityType getScopeSecurityType()

Alters the scope security type (such as AllObjectsInScope, AllObjects, GroupsAdminOf, ...) associated with this task.

Returns:

The basic action type of the task. This method must not return null.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

setScopeSecurityType

void setScopeSecurityType(ScopeSecurityType sst)

Alters the scope security type (such as AllObjectsInScope, AllObjects, GroupsAdminOf, ...) associated with this task.

Parameters:

at - - The scope security type to assign to the task.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

getPrimaryObjectType

ObjectType getPrimaryObjectType()

Retrieves the object type (such as Admin Task, Access Role) associated with this task.

Returns:

The object type of the task. This method must not return null.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

setPrimaryObjectType

void setPrimaryObjectType(ObjectType type)

Alters the object type (such as Admin Task, Access Role) associated with this task.

Parameters:

type - The object type to assign to the task.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

getReservedField

java.lang.String getReservedField(Task.FieldId id)

Retrieves the value of a reserved field.

Parameters:

id - The field identifier.

Returns:

The field value.

setReservedField

void setReservedField(Task.FieldId id,
                      java.lang.String value)

Sets the value of the specified reserved field, overwriting any existing value.

Parameters:

id - The field identifier.

value - The new field value.

getTabControllerTag

java.lang.String getTabControllerTag()
                                     throws SmApiException

Returns the tab controller for this task

Returns:

Throws:

SmApiException

setTabControllerTag

void setTabControllerTag(java.lang.String tabControllerTag)
                         throws SmApiException

Sets the tab controller for this task

Throws:

SmApiException

getTabControllerConfig

PropertyDict getTabControllerConfig()
                                    throws SmApiException

Returns the tab controller configuration dictionary

Returns:

Throws:

SmApiException

setTabControllerConfig

void setTabControllerConfig(PropertyDict tabControllerConfig)
                            throws SmApiException

Sets the tab controller confiuration for this task

Throws:

SmApiException

getTabs

java.util.Vector getTabs()
                         throws com.netegrity.sdk.apiutil.SmApiException

Retrieves all the tabs for this task. Tabs will be ordered within this Vector based on their order values.

Returns:

Vector of the retrieved tab objects.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Task is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Task has already been deleted

com.netegrity.sdk.apiutil.SmApiException

getTabs

java.util.Vector getTabs(TabDefinition type)
                         throws com.netegrity.sdk.apiutil.SmApiException

Retrieves all the tabs of the specified TabDefinition. Tabs will be ordered within this Vector based on their order values.

Parameters:

type - A filter that determines a subset of tabs to return.

Returns:

The returned tab objects.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Task is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Task has already been deleted

com.netegrity.sdk.apiutil.SmApiException

getTab

Tab getTab(java.lang.String tab)
           throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the specified tab.

Parameters:

The - tab tag.

Returns:

A tab object.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSuchObjectException - - If there is not tab with the specified tag on this task

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Task is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Task has already been deleted

com.netegrity.sdk.apiutil.SmApiException

createTab

Tab createTab(java.lang.String tag,
              java.lang.String tabID,
              int order)
              throws com.netegrity.sdk.apiutil.SmApiException

Adds a new tab for this task.

This method is typically used by Identity Manager.

Parameters:

tag - The unique identifier for this tab within this task.

tabID - The unique identifier for this tab type (that is, tag of tab definition).

order - An integer identifying the order value for this tab object. No ordering is guaranteed for cases where more than one tab on a task have the same order number.

Returns:

The new tab object.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Task is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Task has already been deleted

com.netegrity.sdk.apiutil.SmApiException

clearTabs

void clearTabs()
               throws SmApiException

Removes all tabs from this task. Equivalent to getting each tab and then deleting it.

Throws:

SmApiException

setPrimarySearchScreen

void setPrimarySearchScreen(Screen searchScreen)
                            throws SmApiException

Associates a Screen definition with this task as the primary object search screen for the task -- typically used by Identity Manager.

Parameters:

searchScreen - The search screen definition.

Throws:

SmApiException

getPrimarySearchScreen

Screen getPrimarySearchScreen()
                              throws SmApiException

Retrieves the Screen definition for the primary object search screen associated with this task -- typically used by Identity Manager.

Returns:

A Screen representing the associated definition, or if no screen is associated then null is returned.

Throws:

SmApiException

getTaskHandlerDefinitions

java.util.Vector getTaskHandlerDefinitions()
                                           throws SmApiException

Retrieves all task handler definitions -- typically used by Identity Manager.

Returns:

Vector A vector of TaskHandlerDefinition objects

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSuchObjectException - if the object can not be found

SmApiException - For more general problems with the execution of the call

clearTaskHandlerDefinitions

void clearTaskHandlerDefinitions()
                                 throws SmApiException

Deletes all definitions -- typically used by Identity Manager.

Throws:

SmApiException

getTaskHandlerDefinition

TaskHandlerDefinition getTaskHandlerDefinition(java.lang.String uniqueName)
                                               throws SmApiException,
                                                      NoSuchObjectException

Retrieves the specified TaskHandlerDefinition -- typically used by Identity Manager.

Parameters:

uniqueName - A String identifying the task handler to search for

Returns:

TaskHandlerDefinition The task handler definition

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSuchObjectException - if the object can not be found

SmApiException - For more general problems with the execution of the call

NoSuchObjectException

createTaskHandlerDefinition

TaskHandlerDefinition createTaskHandlerDefinition(java.lang.String uniqueName,
                                                  java.lang.String desc,
                                                  java.lang.String classname,
                                                  AttributeValidationRuleType scriptType,
                                                  java.lang.String script,
                                                  int executionOrder,
                                                  java.util.Hashtable userprops)
                                                  throws SmApiException

Creates a task handler definition -- typically used by Identity Manager.

Parameters:

uniqueName - A String identifying the task handler

desc - The description for the task handler

classname - The fully qualified name of class that implements the task handler

scriptType - The script type. Could be UNKNOWN, JAVA or JAVASCRIPT

script - The script itself or null

executionOrder - order of the handler execution

Returns:

TaskHandlerDefinition The task handler definition

Throws:

SmApiException - For more general problems with the execution of the call

getAutoSynch

AutoSynchType getAutoSynch()

Determines whether the task triggers automatic firing of a user synchronization event when this task leaves the pending state.

Returns:

A value that specifies the automatic synchronization behavior of the task. Possible values are:

• OFF
. Automatic synchronization is disabled.
• AT_END
. Synchronization occurs at the completion of the task.
• EVERY_EVENT
. Synchronization occurs at the completion of each event.
• UNKNOWN
. The synchronization flag cannot be determined.

See AutoSynchType for more information.

Throws:

DeletedObjectException

Since:

Identity Manager 8.1

setAutoSynch

void setAutoSynch(AutoSynchType synch)

Alters the synchronization flag for the task.

Parameters:

synch - One of the values of AutoSynchType flag, which are:

• OFF
. Automatic synchronization is disabled.
• AT_END
. Synchronization occurs at the completion of the task.
• EVERY_EVENT
. Synchronization occurs at the completion of each event.

See AutoSynchType for more information.

Throws:

DeletedObjectException

Since:

Identity Manager 8.1

getAutoAccountSynch

AutoSynchType getAutoAccountSynch()

Determines whether automatic synchronization between the user's provisioning roles in the eTrust Admin directory and the associated role definitions in the Identity Manager environment is enabled, and if so, when synchronization occurs.

Note: This method requires an instance of an eTrust Admin Directory.

Returns:

A value that specifies the automatic synchronization behavior of the task. Possible values are:

• OFF
. Automatic synchronization is disabled.
• AT_END
. Synchronization occurs at the completion of the task.
• EVERY_EVENT
. Synchronization occurs at the completion of each event.
• UNKNOWN
. The synchronization flag cannot be determined.

Throws:

DeletedObjectException

Since:

Identity Manager 8.1

setAutoAccountSynch

void setAutoAccountSynch(AutoSynchType synch)

Alters the automatic synchronization flag for the user's eTrust Admin provisioning accounts.

This method affects synchronization between the user's provisioning roles in the eTrust Admin directory and the associated role definitions in the Identity Manager environment.

Note: This method requires an instance of an eTrust Admin Directory.

Parameters:

synch - One of the values of the AutoSynchType flag, which are:

• OFF
. Automatic synchronization is disabled.
• AT_END
. Synchronization occurs at the completion of the task.
• EVERY_EVENT
. Synchronization occurs at the completion of each event.

Throws:

DeletedObjectException

Since:

Identity Manager 8.1

See Also:

synchChangesWithAccounts(), synchProvisioningRolesAddAccounts(), synchProvisioningRolesDeleteAccounts()

getTaskCategory2

java.lang.String getTaskCategory2()

Find out the Level 2 category of the Task associated with this TaskDefinition. This method returns a unique identifier for a Subcategory.

Returns:

String The task level 2 category.

setTaskCategory2

void setTaskCategory2(java.lang.String newCategory2)

Set the level2 category of the Task associated with this TaskDefinition

Parameters:

level2category - A String uniquely identifying the new level2 category.

getTaskCategory3

java.lang.String getTaskCategory3()

Find out the Level 3 category of the Task associated with this TaskDefinition. This method returns a unique identifier for a Subcategory.

Returns:

String The task level 3 category.

setTaskCategory3

void setTaskCategory3(java.lang.String newCategory3)

Set the level 3 category of the Task associated with this TaskDefinition

Parameters:

level3category - A String uniquely identifying the new level3 category.

getTaskOrder

int getTaskOrder()

Return the task order associated with this Task. May not be null.

Returns:

TaskOrder an int type capturing the task order of this task

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

setTaskOrder

void setTaskOrder(int taskOrder)

Alter the task order associated with this Task.

Parameters:

taskOrder - - An integer value representing the task order to assign to the task

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

setCategoryOrder

void setCategoryOrder(int categoryOrder)

Sets the Category order for the task

Parameters:

categoryOrder - -the category order

getCategoryOrder

int getCategoryOrder()

Returns the Category Order

Returns:

int Category Order

setCategory2Order

void setCategory2Order(int categoryOrder)

Sets the Level 2 category order for the task

Parameters:

categoryOrder - - the category order

getCategory2Order

int getCategory2Order()

Returns the Level 2 category Order for the task

Returns:

int CategoryOrder

setCategory3Order

void setCategory3Order(int categoryOrder)

Sets the Level 3 category order for the task

Parameters:

categoryOrder - - the category order

getCategory3Order

int getCategory3Order()

Returns the Level 3 category Order for the task

Returns:

int CategoryOrder

setPriority

void setPriority(int priority)
                 throws SmApiException

Sets the priority for the task

Parameters:

priority - - the task Priority

Throws:

SmApiException

getPriority

int getPriority()
                throws SmApiException

Returns the priority for the task

Returns:

int priority

Throws:

SmApiException

setAutomaticExecution

void setAutomaticExecution(boolean autoexec)
                           throws SmApiException

Sets the flag for automatic execution of the task

Parameters:

autoexec - - the flag indicating automatic execution

Throws:

SmApiException

isAutomaticExecution

boolean isAutomaticExecution()
                             throws SmApiException

Returns the the flag for the automatic execution of the task

Returns:

boolean auotmatic execution flag

Throws:

SmApiException

getConfigPropertyDict

PropertyDict getConfigPropertyDict()
                                   throws SmApiException

Get configuration property dictionary To set the configuration property dictionary back use setLinkedDataDict

Returns:

PropertyDict

Throws:

SmApiException