Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUserGroupDataFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractUserGroupDef
        |
        +--com.ibm.mm.sdk.common.DKUserGroupDataFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, dkUserGroupDef, java.io.Serializable

public class DKUserGroupDataFed
extends dkAbstractUserGroupDef
implements DKConstantFed, DKMessageIdFed, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKUserGroupDataFed()
          Constructs and initializes a user group class.
DKUserGroupDataFed(dkDatastore ds)
          Constructs and initializes a user group class associated with a given datastore.
DKUserGroupDataFed(java.lang.String name)
          Constructs and initializes a user group class associated with a specified name.
 
Method Summary
 void addUser(dkUserDef userDef)
          Adds a new user to this user group (memory-only)
 void clearCache()
          Clear user group cache
 long getDomainId()
          Gets the admin domain id that this user group belongs to
 java.lang.String getDomainName()
          Gets the admin domain name that this user group belongs to
 java.lang.String getNewUserGroupName()
          Deprecated.  
 int getUserGroupID()
          Deprecated.  
 java.lang.String getUserGroupName()
          Deprecated.  
 java.util.Vector getUsers()
          Gets users from this user group
 boolean isRetrieved()
          Checks whether the users of this group have been retrieved
 java.lang.String[] listUserNames()
          Gets a list of user names defined to the user group from persistent datastore, if not cached
 dkCollection listUsers()
          Gets a list of users in this user group from the persistent datastore
 void removeUser(java.lang.String userName)
          Removes a user from this user group (memory-only)
 void setDomainId(long id)
          Sets admin domain ide that this user group belongs to
 void setDomainName(java.lang.String name)
          Sets admin domain name that this user group belongs to
 void setNewUserGroupName(java.lang.String name)
          Deprecated.  
 void setRetrieved(boolean isRetrieved)
          Sets whether the user has been retrieved
 void setUserGroupID(int id)
          Set the ID that representing this UserGroup in the Federated database.
 void setUserGroupName(java.lang.String name)
          Deprecated.  
 void setUsers(java.util.Vector v)
          Sets users to this user group
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserGroupDef
datastoreType, getDatastore, getDescription, getName, setDatastore, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKUserGroupDataFed

public DKUserGroupDataFed()
Constructs and initializes a user group class.

This class represents a user group in the Library Server.

  DKUserGroupDataFed userGroup = new DKUserGroupDataFed();
  
See Also:
dkUserGroupDef, dkAbstractUserGroupDef

DKUserGroupDataFed

public DKUserGroupDataFed(java.lang.String name)
Constructs and initializes a user group class associated with a specified name.

This class represents a user group in the Library Server.

  DKUserGroupDataFed userGroup = new DKUserGroupDataFed(String name);
  
Parameters:
String - name reference
See Also:
dkUserGroupDef, dkAbstractUserGroupDef

DKUserGroupDataFed

public DKUserGroupDataFed(dkDatastore ds)
Constructs and initializes a user group class associated with a given datastore.

This class represents a user group in the Library Server.

  DKUserGroupDataFed userGroup = new DKUserGroupDataFed(ds);
  
Parameters:
ds - dkDatastore reference
See Also:
dkUserGroupDef, dkAbstractUserGroupDef
Method Detail

getUserGroupName

public java.lang.String getUserGroupName()
Deprecated.  

Gets the user group name
Returns:
the name of the user group

setUserGroupName

public void setUserGroupName(java.lang.String name)
Deprecated.  

Sets the user group name
Parameters:
name(String) - - the name for the user

getNewUserGroupName

public java.lang.String getNewUserGroupName()
                                     throws java.lang.Exception
Deprecated.  

Get the new UserGroup name.

setNewUserGroupName

public void setNewUserGroupName(java.lang.String name)
                         throws java.lang.Exception
Deprecated.  

Set the new UserGroup name.

getUserGroupID

public int getUserGroupID()
                   throws java.lang.Exception
Deprecated.  

Get the ID that representing this UserGroup in the Federated database.

setUserGroupID

public void setUserGroupID(int id)
                    throws java.lang.Exception
Set the ID that representing this UserGroup in the Federated database. deprecated

isRetrieved

public boolean isRetrieved()
Checks whether the users of this group have been retrieved
Returns:
true if already retrieved, false otherwise

setRetrieved

public void setRetrieved(boolean isRetrieved)
Sets whether the user has been retrieved
Parameters:
isRetrieved - true if already retrieved, false otherwise

setUsers

public void setUsers(java.util.Vector v)
              throws DKException,
                     java.lang.Exception
Sets users to this user group
Parameters:
v - a vector containing DKUserDefFed object

getUsers

public java.util.Vector getUsers()
Gets users from this user group
Parameters:
v - a vector containing DKUserDefFed object

listUsers

public dkCollection listUsers()
                       throws DKException,
                              java.lang.Exception
Gets a list of users in this user group from the persistent datastore
Overrides:
listUsers in class dkAbstractUserGroupDef
Returns:
a collection of user objects
Throws:
DKException - when error occurs in the server

listUserNames

public java.lang.String[] listUserNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of user names defined to the user group from persistent datastore, if not cached
Overrides:
listUserNames in class dkAbstractUserGroupDef
Returns:
an array of user names

addUser

public void addUser(dkUserDef userDef)
             throws DKAlreadyExistException,
                    DKException,
                    java.lang.Exception
Adds a new user to this user group (memory-only)
Overrides:
addUser in class dkAbstractUserGroupDef
Parameters:
userDef - a DKUserDataFed object
Throws:
DKAlreadyExitsException - if the userDef already exists in this DKUserGroupDataFed object
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKUserDataFed, dkUserDef

removeUser

public void removeUser(java.lang.String userName)
                throws DKNotExistException,
                       DKException
Removes a user from this user group (memory-only)
Overrides:
removeUser in class dkAbstractUserGroupDef
Parameters:
userName - name of the user to be deleted
Throws:
DKNotExistException - if the user name does not exist in this user group.
DKException - when error occurs

getDomainName

public java.lang.String getDomainName()
Gets the admin domain name that this user group belongs to
Returns:
_domainname that this user group belongs to

setDomainName

public void setDomainName(java.lang.String name)
Sets admin domain name that this user group belongs to
Parameters:
name - String - admin domain name of this user group belongs to

getDomainId

public long getDomainId()
Gets the admin domain id that this user group belongs to
Returns:
_domainId that this user group belongs to

setDomainId

public void setDomainId(long id)
Sets admin domain ide that this user group belongs to
Parameters:
id - long - admin domain id of this user group belongs to

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear user group cache
Overrides:
clearCache in class dkAbstractUserGroupDef

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.