oracle.panama.portal
Class GroupController

java.lang.Object
  |
  +--oracle.panama.portal.GroupController

All Implemented Interfaces:

java.io.Serializable

public class GroupController

extends java.lang.Object

implements java.io.Serializable

GroupController handles group related operations, such as retrieving/updating parameters of a group, creating/deleting a group. GroupController also provides the functionality of querying all the users of a group, move users from/to group.

See Also:

Serialized Form

Field Summary

Type	Field
static java.lang.String	GROUPFOLDER Key for retrieving group foler value from the parameter Hashtable passing to/from the portal pages.
static java.lang.String	GROUPID Key for retrieving group id value from the parameter Hashtable passing to/from the portal pages.
static java.lang.String	GROUPNAME Key for retrieving group name value from the parameter Hashtable passing to/from the portal pages.

Method Summary

Type	Method
void	addMultiUserToGroups(java.lang.String[] userIdStrings, java.lang.String[] groupIdStrings, Request apiRequest) for administrator add multiple users to multiple groups
Group	createNewGroup(java.lang.String name, Request apiRequest) for administrator create a new group.
void	deleteGroup(long groupId, Request apiRequest) for administrator delete a group.
Group[]	getAllGroups(Request apiRequest) for administrator get all the groups.
Group	getGroup(java.lang.String groupIdString, Request apiRequest) get the group from group Id
Service[]	getGroupServices(long groupId, Request apiRequest) for administrator get the root services for a group.
Folder[]	getGroupUpdatableFolders(java.lang.String groupName, Request apiRequest) for administrator get all the folders and subfolders for a group
void	getGroupUserList(long groupId, Request apiRequest) for administrator Start the query of the user list of a group.
static GroupController	getInstance() The singleton thread-safe getter.
java.util.Hashtable	getParametersHash(long groupId, Request apiRequest) for administrator get parameter name-value Hashtable of a group.
boolean	isGroupService(long groupId, long serviceId, Request apiRequest) for administrator check to see whether a service belong to a group.
void	removeMultiUserFromGroups(java.lang.String[] userIdStrings, java.lang.String[] groupIdStrings, Request apiRequest) for administrator remove multiple users from multiple groups
void	setMultiUserToGroups(java.lang.String[] userIdStrings, java.lang.String[] groupIdStrings, Request apiRequest) for administrator set multiple users to multiple groups
void	setParameters(long groupId, java.util.Hashtable paramHash, Request apiRequest) for administrator set parameter values of a group.
void	setRootServiceHash(long groupId, java.util.Hashtable rootServiceHash, Request apiRequest) for administrator add/remove root services to/from the group.

Methods inherited from class java.lang.Object

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

Field Detail

GROUPID

public static final java.lang.String GROUPID

Key for retrieving group id value from the parameter Hashtable passing to/from the portal pages.

GROUPNAME

public static final java.lang.String GROUPNAME

Key for retrieving group name value from the parameter Hashtable passing to/from the portal pages.

GROUPFOLDER

public static final java.lang.String GROUPFOLDER

Key for retrieving group foler value from the parameter Hashtable passing to/from the portal pages.

Method Detail

getInstance

public static GroupController getInstance()

The singleton thread-safe getter.

Returns:

the GroupController singleton interface.

getAllGroups

public Group[] getAllGroups(Request apiRequest)
                     throws PortalException

for administrator get all the groups.

Parameters:

apiRequest - current validated Request.

Returns:

group array of all the groups

getParametersHash

public java.util.Hashtable getParametersHash(long groupId,
                                             Request apiRequest)
                                      throws PortalException

for administrator get parameter name-value Hashtable of a group.

Parameters:

groupId - queried group ID.

apiRequest - current validated Request.

Returns:

parameter name-value Hashtable of a group.

setParameters

public void setParameters(long groupId,
                          java.util.Hashtable paramHash,
                          Request apiRequest)
                   throws PortalException

for administrator set parameter values of a group.

Parameters:

groupId - queried group ID.

parameters - parameter name-value Hashtable to update

apiRequest - current validated Request.

createNewGroup

public Group createNewGroup(java.lang.String name,
                            Request apiRequest)
                     throws PortalException

for administrator create a new group.

Parameters:

name - new group name.

apiRequest - current validated Request.

Returns:

the new Group.

deleteGroup

public void deleteGroup(long groupId,
                        Request apiRequest)
                 throws PortalException

for administrator delete a group.

Parameters:

groupId - deleted group ID.

isGroupService

public boolean isGroupService(long groupId,
                              long serviceId,
                              Request apiRequest)
                       throws PortalException

for administrator check to see whether a service belong to a group.

Parameters:

groupId - queried group ID.

serviceId - queried service ID.

Request - current validated Request

Returns:

true if the service belongs to a group, otherwise false

getGroup

public Group getGroup(java.lang.String groupIdString,
                      Request apiRequest)
               throws PortalException

get the group from group Id

Parameters:

groupIdString - group Id String.

apiRequest - current validated api.

Returns:

group

getGroupUpdatableFolders

public Folder[] getGroupUpdatableFolders(java.lang.String groupName,
                                         Request apiRequest)
                                  throws PortalException,
                                         PanamaRuntimeException

for administrator get all the folders and subfolders for a group

Parameters:

groupname - to be checked.

apiRequest - current validated api.

Returns:

folder array

getGroupServices

public Service[] getGroupServices(long groupId,
                                  Request apiRequest)
                           throws PortalException

for administrator get the root services for a group.

Parameters:

groupId - group id.

Request - current validate Request.

Returns:

root service array of the group.

setRootServiceHash

public void setRootServiceHash(long groupId,
                               java.util.Hashtable rootServiceHash,
                               Request apiRequest)
                        throws PortalException

for administrator add/remove root services to/from the group.

Parameters:

groupId - group id.

rootServiceHash - String-Boolean Hashtable, for each of them, String is the service ID String, while Boolean true means adding and Boolean false means removing.

Returns:

root service array of the group.

getGroupUserList

public void getGroupUserList(long groupId,
                             Request apiRequest)
                      throws PortalException

for administrator Start the query of the user list of a group.

Parameters:

groupId - queried group ID.

Request - apiRequest

addMultiUserToGroups

public void addMultiUserToGroups(java.lang.String[] userIdStrings,
                                 java.lang.String[] groupIdStrings,
                                 Request apiRequest)
                          throws PortalException

for administrator add multiple users to multiple groups

Parameters:

userIdStrings - user ID String array

groupIdStrings - group ID String array

apiRequest - current request

removeMultiUserFromGroups

public void removeMultiUserFromGroups(java.lang.String[] userIdStrings,
                                      java.lang.String[] groupIdStrings,
                                      Request apiRequest)
                               throws PortalException

for administrator remove multiple users from multiple groups

Parameters:

userIdStrings - user ID String array

groupIdStrings - group ID String array

apiRequest - current request

setMultiUserToGroups

public void setMultiUserToGroups(java.lang.String[] userIdStrings,
                                 java.lang.String[] groupIdStrings,
                                 Request apiRequest)
                          throws PortalException

for administrator set multiple users to multiple groups

Parameters:

userIdStrings - user ID String array

groupIdStrings - group ID String array

apiRequest - current request