com.iplanet.am.sdk
Interface AMDynamicGroup

All Superinterfaces:
AMConstants, AMGroup, AMObject

public interface AMDynamicGroup
extends AMGroup

This interface provides methods to manage dynamic group. AMDynamicGroup objects can be obtained by using AMStoreConnection. A handle to this object can be obtained by using the DN of the object.

          AMStoreConnection amsc = new AMStoreConnection(ssotoken);
          if (amsc.doesEntryExist(dgDN)) {
              AMDynamicGroup dg = amsc.getDynamicGroup(dgDN);
          }
 


Fields inherited from interface com.iplanet.am.sdk.AMObject
ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER
 
Fields inherited from interface com.iplanet.am.sdk.AMConstants
ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS
 
Method Summary
 java.lang.String getFilter()
          Gets the search filter for the dynamic group.
 void setFilter(java.lang.String filter)
          Sets the search filter for the dynamic group.
 
Methods inherited from interface com.iplanet.am.sdk.AMGroup
createAssignableDynamicGroups, createAssignableDynamicGroups, createDynamicGroups, createDynamicGroups, createStaticGroups, createStaticGroups, deleteAssignableDynamicGroups, deleteDynamicGroups, deleteStaticGroups, getGroupDNs, getNumberOfGroups, getNumberOfUsers, getUserDNs, searchGroups, searchGroups, searchGroups, searchUsers, searchUsers, searchUsers
 
Methods inherited from interface com.iplanet.am.sdk.AMObject
addEventListener, assignPolicies, assignServices, assignServices, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAssignedServices, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getServiceStatus, getStringAttribute, getTemplate, isExists, modifyService, purge, removeAttributes, removeEventListener, search, setAttributeByteArray, setAttributes, setAttributesByteArray, setServiceStatus, setStringAttribute, store, store, unassignPolicies, unassignServices
 

Method Detail

getFilter

public java.lang.String getFilter()
                           throws AMException,
                                  SSOException
Gets the search filter for the dynamic group.
Returns:
The filter in LDIF format for the dynamic group.
Throws:
AMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid

setFilter

public void setFilter(java.lang.String filter)
               throws AMException,
                      SSOException
Sets the search filter for the dynamic group.
Returns:
The filter in LDIF format for the dynamic group.
Throws:
AMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid