com.netegrity.llsdk6.imsapi.search
Class RoleObjectQuery

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

public class RoleObjectQuery
extends ObjectQuery

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

Since:

IdentityMinder 6.0

Constructor Summary

RoleObjectQuery()
Creates a new, empty query.

Method Summary

java.lang.String	getCustom01()
java.lang.String	getCustom02()
java.lang.String	getCustom03()
java.lang.String	getCustom04()
java.lang.String	getCustom05()
java.lang.String	getCustom06()
java.lang.String	getCustom07()
java.lang.String	getCustom08()
java.lang.String	getCustom09()
java.lang.String	getCustom10()
java.util.Hashtable	getFieldMap() This method is typically used by Identity Manager
java.lang.String	getName() Retrieves the role name component of the query.
boolean	getRoleAdminAssignableFlag() Retrieves the assignable component of the query for role administrators.
boolean	getRoleAssignableFlag() Retrieves the assignable component of the query for role members.
boolean	getRoleEnabledFlag() Retrieves the enabled component of the query.
boolean	isSameAsSearchAll() Determines if the query is equivalent to searching for all objects.
boolean	isSetCustom01()
boolean	isSetCustom02()
boolean	isSetCustom03()
boolean	isSetCustom04()
boolean	isSetCustom05()
boolean	isSetCustom06()
boolean	isSetCustom07()
boolean	isSetCustom08()
boolean	isSetCustom09()
boolean	isSetCustom10()
boolean	isSetName()
boolean	isSetRoleAdminAssignableFlag()
boolean	isSetRoleAssignableFlag()
boolean	isSetRoleEnabledFlag()
void	setCustom01(java.lang.String custom1)
void	setCustom02(java.lang.String custom2)
void	setCustom03(java.lang.String custom3)
void	setCustom04(java.lang.String custom4)
void	setCustom05(java.lang.String custom5)
void	setCustom06(java.lang.String custom6)
void	setCustom07(java.lang.String custom7)
void	setCustom08(java.lang.String custom8)
void	setCustom09(java.lang.String custom9)
void	setCustom10(java.lang.String custom10)
void	setName(java.lang.String name) Sets the role name component of the query.
void	setRoleAdminAssignableFlag(boolean assignable) Sets the assignable component of the query for role administrators.
void	setRoleAssignableFlag(boolean assignable) Sets the assignable component of the query for role members.
void	setRoleEnabledFlag(boolean enabled) Sets the enabled component of the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleObjectQuery

public RoleObjectQuery()
                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 role name component of the query.

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

     "where the Role name is X"

Parameters:

name - The role name component of the query.

Throws:

SmApiException

isSetName

public boolean isSetName()

getName

public java.lang.String getName()
                         throws SmApiException

Retrieves the role name component of the query.

Returns:

The role name component of the query.

Throws:

SmApiException

getRoleEnabledFlag

public boolean getRoleEnabledFlag()

Retrieves the enabled component of the query.

Returns:

The enabled component of the query.

setRoleEnabledFlag

public void setRoleEnabledFlag(boolean enabled)

Sets the enabled component of the query.

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

    "where the Role is (or isn't) enabled"

Parameters:

enabled - The enabled component of the query.

isSetRoleEnabledFlag

public boolean isSetRoleEnabledFlag()

getRoleAssignableFlag

public boolean getRoleAssignableFlag()

Retrieves the assignable component of the query for role members.

Returns:

The assignable component of the query for role members.

setRoleAssignableFlag

public void setRoleAssignableFlag(boolean assignable)

Sets the assignable component of the query for role members.

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

     "where the Role is (or isn't) marked as being assignable for role members"

Parameters:

assignable - The assignable component of the query for role members

isSetRoleAssignableFlag

public boolean isSetRoleAssignableFlag()

getRoleAdminAssignableFlag

public boolean getRoleAdminAssignableFlag()

Retrieves the assignable component of the query for role administrators.

Returns:

The assignable component of the query for role administrators

setRoleAdminAssignableFlag

public void setRoleAdminAssignableFlag(boolean assignable)

Sets the assignable component of the query for role administrators.

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

     "where the Role is (or isn't) marked as being assignable for role administrators"

Parameters:

assignable - The assignable component of the query for role administrators.

isSetRoleAdminAssignableFlag

public boolean isSetRoleAdminAssignableFlag()

setCustom01

public void setCustom01(java.lang.String custom1)

isSetCustom01

public boolean isSetCustom01()

getCustom01

public java.lang.String getCustom01()

setCustom02

public void setCustom02(java.lang.String custom2)

isSetCustom02

public boolean isSetCustom02()

getCustom02

public java.lang.String getCustom02()

setCustom03

public void setCustom03(java.lang.String custom3)

isSetCustom03

public boolean isSetCustom03()

getCustom03

public java.lang.String getCustom03()

setCustom04

public void setCustom04(java.lang.String custom4)

isSetCustom04

public boolean isSetCustom04()

getCustom04

public java.lang.String getCustom04()

setCustom05

public void setCustom05(java.lang.String custom5)

isSetCustom05

public boolean isSetCustom05()

getCustom05

public java.lang.String getCustom05()

setCustom06

public void setCustom06(java.lang.String custom6)

isSetCustom06

public boolean isSetCustom06()

getCustom06

public java.lang.String getCustom06()

setCustom07

public void setCustom07(java.lang.String custom7)

isSetCustom07

public boolean isSetCustom07()

getCustom07

public java.lang.String getCustom07()

setCustom08

public void setCustom08(java.lang.String custom8)

isSetCustom08

public boolean isSetCustom08()

getCustom08

public java.lang.String getCustom08()

setCustom09

public void setCustom09(java.lang.String custom9)

isSetCustom09

public boolean isSetCustom09()

getCustom09

public java.lang.String getCustom09()

setCustom10

public void setCustom10(java.lang.String custom10)

isSetCustom10

public boolean isSetCustom10()

getCustom10

public java.lang.String getCustom10()

isSameAsSearchAll

public boolean isSameAsSearchAll()

Determines if the query is equivalent to searching for all objects. If all the filter values defined are exclusively wildcards, the query will effectively be the same as searching for all objects. This semantic equivalence is determined if the query filter values defined are all wildcards e.g. Name ="*".

Returns:

true if query is effectively equivalent to searching for all objects.