|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.panama.portal.GroupController
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.
Field Summary | |
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 | |
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 |
public static final java.lang.String GROUPID
public static final java.lang.String GROUPNAME
public static final java.lang.String GROUPFOLDER
Method Detail |
public static GroupController getInstance()
public Group[] getAllGroups(Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public java.util.Hashtable getParametersHash(long groupId, Request apiRequest) throws PortalException
groupId
- queried group ID.apiRequest
- current validated Request.PortalException
public void setParameters(long groupId, java.util.Hashtable paramHash, Request apiRequest) throws PortalException
groupId
- queried group ID.apiRequest
- current validated Request.PortalException
public Group createNewGroup(java.lang.String name, Request apiRequest) throws PortalException
name
- new group name.apiRequest
- current validated Request.PortalException
public void deleteGroup(long groupId, Request apiRequest) throws PortalException
groupId
- deleted group ID.PortalException
public boolean isGroupService(long groupId, long serviceId, Request apiRequest) throws PortalException
groupId
- queried group ID.serviceId
- queried service ID.PortalException
public Group getGroup(java.lang.String groupIdString, Request apiRequest) throws PortalException
groupIdString
- group Id String.apiRequest
- current validated api.PortalException
public Folder[] getGroupUpdatableFolders(java.lang.String groupName, Request apiRequest) throws PortalException, PanamaRuntimeException
apiRequest
- current validated api.PortalException
PanamaRuntimeException
public Service[] getGroupServices(long groupId, Request apiRequest) throws PortalException
groupId
- group id.PortalException
public void setRootServiceHash(long groupId, java.util.Hashtable rootServiceHash, Request apiRequest) throws PortalException
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.PortalException
public void getGroupUserList(long groupId, Request apiRequest) throws PortalException
groupId
- queried group ID.PortalException
public void addMultiUserToGroups(java.lang.String[] userIdStrings, java.lang.String[] groupIdStrings, Request apiRequest) throws PortalException
userIdStrings
- user ID String arraygroupIdStrings
- group ID String arrayapiRequest
- current requestPortalException
public void removeMultiUserFromGroups(java.lang.String[] userIdStrings, java.lang.String[] groupIdStrings, Request apiRequest) throws PortalException
userIdStrings
- user ID String arraygroupIdStrings
- group ID String arrayapiRequest
- current requestPortalException
public void setMultiUserToGroups(java.lang.String[] userIdStrings, java.lang.String[] groupIdStrings, Request apiRequest) throws PortalException
userIdStrings
- user ID String arraygroupIdStrings
- group ID String arrayapiRequest
- current requestPortalException
|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |