com.netegrity.llsdk6.imsapi.search
Class TaskObjectQuery

java.lang.Object
  ObjectQuery
      com.netegrity.llsdk6.imsapi.search.TaskObjectQuery

public class TaskObjectQuery
extends ObjectQuery

Defines a query on the full set of task objects in the current Identity Manager environment.

Since:

IdentityMinder 6.0

Constructor Summary

TaskObjectQuery()
Creates a new, empty query.

Method Summary

ActionType	getActionType() Retrieves the action type component of the query.
java.lang.String	getApplication() Retrieves the application name component of the query.
java.lang.String	getCategory() Retrieves the task category component of the query.
java.lang.String	getCategory2() Retrieves the level 2 task category component of the query.
int	getCategory2Order() Retrieves the level 2 task category order component of the query.
java.lang.String	getCategory3() Retrieves the level 3 task category component of the query.
int	getCategory3Order() Retrieves the level 3 task category order component of the query.
int	getCategoryOrder() Retrieves the task category order component of the query.
java.util.Hashtable	getFieldMap() This method is typically used by Identity Manager
java.lang.String	getName() Retrieves the task name component of the query.
ObjectType	getObjectType() Retrieves the object type component of the query.
java.lang.String	getReserved1() Retrieves the reserved field 1 component of the query.
java.lang.String	getReserved10() Retrieves the reserved field 10 component of the query.
java.lang.String	getReserved2() Retrieves the reserved field 2 component of the query.
java.lang.String	getReserved3() Retrieves the reserved field 3 component of the query.
java.lang.String	getReserved4() Retrieves the reserved field 4 component of the query.
java.lang.String	getReserved5() Retrieves the reserved field 5 component of the query.
java.lang.String	getReserved6() Retrieves the reserved field 6 component of the query.
java.lang.String	getReserved7() Retrieves the reserved field 7 component of the query.
java.lang.String	getReserved8() Retrieves the reserved field 8 component of the query.
java.lang.String	getReserved9() Retrieves the reserved field 9 component of the query.
java.lang.String	getTag() Retrieves the tag component of the query.
int	getTaskOrder() Retrieves the task order component of the query.
java.lang.String	getURL() Retrieves the external URL component of the query.
java.lang.String	getWorkflowID() Retrieves the workflow ID component of the query.
boolean	isAutomaticExecution() Retrieves the task subcategory order component of the query.
boolean	isSetActionType()
boolean	isSetApplication()
boolean	isSetAutomaticExecution()
boolean	isSetCategory()
boolean	isSetCategory2()
boolean	isSetCategory2Order()
boolean	isSetCategory3()
boolean	isSetCategory3Order()
boolean	isSetCategoryOrder()
boolean	isSetName()
boolean	isSetObjectType()
boolean	isSetReserved1()
boolean	isSetReserved10()
boolean	isSetReserved2()
boolean	isSetReserved3()
boolean	isSetReserved4()
boolean	isSetReserved5()
boolean	isSetReserved6()
boolean	isSetReserved7()
boolean	isSetReserved8()
boolean	isSetReserved9()
boolean	isSetTag()
boolean	isSetTaskOrder()
boolean	isSetURL()
boolean	isSetWorkflowID()
void	setActionType(ActionType type) Sets the action type component of the query.
void	setApplication(java.lang.String application) Sets the application name component of the query.
void	setAutomaticExecution(boolean automaticExecution) Sets the task flag for automatic execution.
void	setCategory(java.lang.String category) Sets the task category component of the query.
void	setCategory2(java.lang.String category2) Sets the level 2 task category component of the query.
void	setCategory2Order(int categoryOrder) Sets the task level 2 category order.
void	setCategory3(java.lang.String category3) Sets the level 3 task category component of the query.
void	setCategory3Order(int categoryOrder) Sets the task level 3 category order.
void	setCategoryOrder(int categoryOrder) Sets the task category order.
void	setName(java.lang.String name) Sets the task name component of the query.
void	setObjectType(ObjectType type) Sets the object type component of the query.
void	setReserved1(java.lang.String res) Sets the reserved field 1 component of the query.
void	setReserved10(java.lang.String res) Sets the reserved field 10 component of the query.
void	setReserved2(java.lang.String res) Sets the reserved field 2 component of the query.
void	setReserved3(java.lang.String res) Sets the reserved field 3 component of the query.
void	setReserved4(java.lang.String res) Sets the reserved field 4 component of the query.
void	setReserved5(java.lang.String res) Sets the reserved field 5 component of the query.
void	setReserved6(java.lang.String res) Sets the reserved field 6 component of the query.
void	setReserved7(java.lang.String res) Sets the reserved field 7 component of the query.
void	setReserved8(java.lang.String res) Sets the reserved field 8 component of the query.
void	setReserved9(java.lang.String res) Sets the reserved field 9 component of the query.
void	setTag(java.lang.String tag) Sets the tag component of the query.
void	setTaskOrder(int taskOrder) Sets the task order.
void	setURL(java.lang.String url) Sets the external URL component of the query.
void	setWorkflowID(java.lang.String ID) Sets the workflow ID component of the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskObjectQuery

public TaskObjectQuery()
                throws SmApiException

Creates a new, empty query.

Throws:

SmApiException

Method Detail

getFieldMap

public java.util.Hashtable getFieldMap()

This method is typically used by Identity Manager

setName

public void setName(java.lang.String name)
             throws SmApiException

Sets the task name component of the query.

This is similar to adding a clause to the search such as:

     "where the Task name is X"

Parameters:

name - The task name component of the query.

Throws:

SmApiException

isSetName

public boolean isSetName()

getName

public java.lang.String getName()
                         throws SmApiException

Retrieves the task name component of the query.

Returns:

The task name component of the query.

Throws:

SmApiException

setCategory

public void setCategory(java.lang.String category)
                 throws SmApiException

Sets the task category component of the query.

This is similar to adding a clause to the search such as:

     "where the Task category is X"

Parameters:

category - The task category component of the query.

Throws:

SmApiException

isSetCategory

public boolean isSetCategory()

getCategory

public java.lang.String getCategory()
                             throws SmApiException

Retrieves the task category component of the query.

Returns:

The task category component of the query.

Throws:

SmApiException

setWorkflowID

public void setWorkflowID(java.lang.String ID)
                   throws SmApiException

Sets the workflow ID component of the query.

This is similar to adding a clause to the search such as:

     "where the Task's workflowID is X"

Parameters:

ID - The workflow ID component of the query.

Throws:

SmApiException

isSetWorkflowID

public boolean isSetWorkflowID()

getWorkflowID

public java.lang.String getWorkflowID()
                               throws SmApiException

Retrieves the workflow ID component of the query.

Returns:

The workflow ID component of the query.

Throws:

SmApiException

setApplication

public void setApplication(java.lang.String application)
                    throws SmApiException

Sets the application name component of the query.

This is similar to adding a clause to the search such as:

     "where the Task's application name is X"

Parameters:

application - The application name component of the query.

Throws:

SmApiException

isSetApplication

public boolean isSetApplication()

getApplication

public java.lang.String getApplication()
                                throws SmApiException

Retrieves the application name component of the query.

Returns:

The application name component of the query.

Throws:

SmApiException

setURL

public void setURL(java.lang.String url)
            throws SmApiException

Sets the external URL component of the query.

( This is similar to adding a clause to the search such as:

     "where the Task's external URL is X"

Parameters:

url - The external URL component of the query.

Throws:

SmApiException

isSetURL

public boolean isSetURL()

getURL

public java.lang.String getURL()
                        throws SmApiException

Retrieves the external URL component of the query.

Returns:

The external URL component of the query.

Throws:

SmApiException

getActionType

public ActionType getActionType()

Retrieves the action type component of the query.

Returns:

The action type component of the query.

setActionType

public void setActionType(ActionType type)

Sets the action type component of the query.

Parameters:

type - The action type component of the query.

isSetActionType

public boolean isSetActionType()

getObjectType

public ObjectType getObjectType()

Retrieves the object type component of the query.

Returns:

The object type component of the query.

setObjectType

public void setObjectType(ObjectType type)

Sets the object type component of the query.

Parameters:

type - The object type component of the query.

isSetObjectType

public boolean isSetObjectType()

setTag

public void setTag(java.lang.String tag)
            throws SmApiException

Sets the tag component of the query.

Parameters:

tag - The tag component of the query.

Throws:

SmApiException

isSetTag

public boolean isSetTag()

getTag

public java.lang.String getTag()
                        throws SmApiException

Retrieves the tag component of the query.

Returns:

The tag component of the query.

Throws:

SmApiException

setReserved1

public void setReserved1(java.lang.String res)
                  throws SmApiException

Sets the reserved field 1 component of the query.

Parameters:

res - The reserved field 1 component of the query.

Throws:

SmApiException

isSetReserved1

public boolean isSetReserved1()

getReserved1

public java.lang.String getReserved1()
                              throws SmApiException

Retrieves the reserved field 1 component of the query.

Returns:

The reserved field 1 component of the query.

Throws:

SmApiException

setReserved2

public void setReserved2(java.lang.String res)
                  throws SmApiException

Sets the reserved field 2 component of the query.

Parameters:

res - The reserved field 2 component of the query.

Throws:

SmApiException

isSetReserved2

public boolean isSetReserved2()

getReserved2

public java.lang.String getReserved2()
                              throws SmApiException

Retrieves the reserved field 2 component of the query.

Returns:

The reserved field 2 component of the query.

Throws:

SmApiException

setReserved3

public void setReserved3(java.lang.String res)
                  throws SmApiException

Sets the reserved field 3 component of the query.

Parameters:

res - The reserved field 3 component of the query.

Throws:

SmApiException

isSetReserved3

public boolean isSetReserved3()

getReserved3

public java.lang.String getReserved3()
                              throws SmApiException

Retrieves the reserved field 3 component of the query.

Returns:

The reserved field 3 component of the query.

Throws:

SmApiException

setReserved4

public void setReserved4(java.lang.String res)
                  throws SmApiException

Sets the reserved field 4 component of the query.

Parameters:

res - The reserved field 4 component of the query.

Throws:

SmApiException

isSetReserved4

public boolean isSetReserved4()

getReserved4

public java.lang.String getReserved4()
                              throws SmApiException

Retrieves the reserved field 4 component of the query.

Returns:

The reserved field 4 component of the query.

Throws:

SmApiException

setReserved5

public void setReserved5(java.lang.String res)
                  throws SmApiException

Sets the reserved field 5 component of the query.

Parameters:

res - The reserved field 5 component of the query.

Throws:

SmApiException

isSetReserved5

public boolean isSetReserved5()

getReserved5

public java.lang.String getReserved5()
                              throws SmApiException

Retrieves the reserved field 5 component of the query.

Returns:

The reserved field 5 component of the query.

Throws:

SmApiException

setReserved6

public void setReserved6(java.lang.String res)
                  throws SmApiException

Sets the reserved field 6 component of the query.

Parameters:

res - The reserved field 6 component of the query.

Throws:

SmApiException

isSetReserved6

public boolean isSetReserved6()

getReserved6

public java.lang.String getReserved6()
                              throws SmApiException

Retrieves the reserved field 6 component of the query.

Returns:

The reserved field 6 component of the query.

Throws:

SmApiException

setReserved7

public void setReserved7(java.lang.String res)
                  throws SmApiException

Sets the reserved field 7 component of the query.

Parameters:

res - The reserved field 7 component of the query.

Throws:

SmApiException

isSetReserved7

public boolean isSetReserved7()

getReserved7

public java.lang.String getReserved7()
                              throws SmApiException

Retrieves the reserved field 7 component of the query.

Returns:

The reserved field 7 component of the query.

Throws:

SmApiException

setReserved8

public void setReserved8(java.lang.String res)
                  throws SmApiException

Sets the reserved field 8 component of the query.

Parameters:

res - The reserved field 8 component of the query.

Throws:

SmApiException

isSetReserved8

public boolean isSetReserved8()

getReserved8

public java.lang.String getReserved8()
                              throws SmApiException

Retrieves the reserved field 8 component of the query.

Returns:

The reserved field 8 component of the query.

Throws:

SmApiException

setReserved9

public void setReserved9(java.lang.String res)
                  throws SmApiException

Sets the reserved field 9 component of the query.

Parameters:

res - The reserved field 9 component of the query.

Throws:

SmApiException

isSetReserved9

public boolean isSetReserved9()

getReserved9

public java.lang.String getReserved9()
                              throws SmApiException

Retrieves the reserved field 9 component of the query.

Returns:

The reserved field 9 component of the query.

Throws:

SmApiException

setReserved10

public void setReserved10(java.lang.String res)
                   throws SmApiException

Sets the reserved field 10 component of the query.

Parameters:

res - The reserved field 10 component of the query.

Throws:

SmApiException

isSetReserved10

public boolean isSetReserved10()

getReserved10

public java.lang.String getReserved10()
                               throws SmApiException

Retrieves the reserved field 10 component of the query.

Returns:

The reserved field 10 component of the query.

Throws:

SmApiException

setCategory2

public void setCategory2(java.lang.String category2)
                  throws SmApiException

Sets the level 2 task category component of the query.

This is similar to adding a clause to the search such as:

     "where the Task category2 is X"

Parameters:

category2 - The task category component of the query.

Throws:

SmApiException

isSetCategory2

public boolean isSetCategory2()

getCategory2

public java.lang.String getCategory2()
                              throws SmApiException

Retrieves the level 2 task category component of the query.

Returns:

The task category2 component of the query.

Throws:

SmApiException

setCategory3

public void setCategory3(java.lang.String category3)
                  throws SmApiException

Sets the level 3 task category component of the query.

This is similar to adding a clause to the search such as:

     "where the Task category3 is X"

Parameters:

category3 - The task category component of the query.

Throws:

SmApiException

isSetCategory3

public boolean isSetCategory3()

getCategory3

public java.lang.String getCategory3()
                              throws SmApiException

Retrieves the level 3 task category component of the query.

Returns:

The task category3 component of the query.

Throws:

SmApiException

setTaskOrder

public void setTaskOrder(int taskOrder)
                  throws SmApiException

Sets the task order.

Parameters:

taskOrder - The task category component of the query.

Throws:

SmApiException

isSetTaskOrder

public boolean isSetTaskOrder()

getTaskOrder

public int getTaskOrder()
                 throws SmApiException

Retrieves the task order component of the query.

Returns:

The task category component of the query.

Throws:

SmApiException

setCategoryOrder

public void setCategoryOrder(int categoryOrder)
                      throws SmApiException

Sets the task category order.

Parameters:

categoryOrder - The task category order component of the query.

Throws:

SmApiException

isSetCategoryOrder

public boolean isSetCategoryOrder()

getCategoryOrder

public int getCategoryOrder()
                     throws SmApiException

Retrieves the task category order component of the query.

Returns:

The task category order component of the query.

Throws:

SmApiException

setCategory2Order

public void setCategory2Order(int categoryOrder)
                       throws SmApiException

Sets the task level 2 category order.

Parameters:

categoryOrder - The level 2 task category order component of the query.

Throws:

SmApiException

isSetCategory2Order

public boolean isSetCategory2Order()

getCategory2Order

public int getCategory2Order()
                      throws SmApiException

Retrieves the level 2 task category order component of the query.

Returns:

The level 2 task categoryOrder order component of the query.

Throws:

SmApiException

setCategory3Order

public void setCategory3Order(int categoryOrder)
                       throws SmApiException

Sets the task level 3 category order.

Parameters:

categoryOrder - The level 3 task category order component of the query.

Throws:

SmApiException

isSetCategory3Order

public boolean isSetCategory3Order()

getCategory3Order

public int getCategory3Order()
                      throws SmApiException

Retrieves the level 3 task category order component of the query.

Returns:

The level 3 task categoryOrder order component of the query.

Throws:

SmApiException

setAutomaticExecution

public void setAutomaticExecution(boolean automaticExecution)
                           throws SmApiException

Sets the task flag for automatic execution.

Parameters:

automaticExecution -

Throws:

SmApiException

isSetAutomaticExecution

public boolean isSetAutomaticExecution()

isAutomaticExecution

public boolean isAutomaticExecution()
                             throws SmApiException

Retrieves the task subcategory order component of the query.

Returns:

The Automatic Execution component of the query.

Throws:

SmApiException