Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

oracle.apps.fnd.applcore.dataSecurity.uiModel.util
Class ActionMap

java.lang.Object
  extended by oracle.apps.fnd.applcore.dataSecurity.uiModel.util.ActionMap
All Implemented Interfaces:
java.io.Serializable

public class ActionMap
extends java.lang.Object
implements java.io.Serializable

This class contains complete definition of an action against which grants are to be made in the security UIs.

See Also:
Serialized Form

Nested Class Summary
static class ActionMap.ACTION_TYPE
          Enumeration to indicate Action Type.
 
Method Summary
 java.lang.String getAction()
          Get Action Display Name.
static ActionMap getActionMapForInstanceUI(java.lang.String actionDisplay, java.lang.String aggregatePrivilegeName)
          This api is to be used in conjunction with the instance level UI.
static ActionMap getActionMapForObjectUI(java.lang.String actionDisplay, java.lang.String aggregatePrivilegeName, java.lang.String permissionSetName, boolean isFSOnly, java.util.List<java.lang.String> instanceSetNames)
          This api is to be used in conjunction with the Object level UI.
static ActionMap getActionMapForProfileUI(java.lang.String actionDisplay, java.util.List<ProfileActionObject> profileActionObjects)
          This api is to be used in conjunction with the Profile UI.
 ActionMap.ACTION_TYPE getActionType()
          Get Type of the Action Map.
 java.util.List<java.lang.String> getInstanceSetNames()
          Gets the instance set Name.(for type OBJECT only)
 java.lang.Long getMenuId()
          Getter for menu ID (used for internal validation).
 java.lang.String getPermissionSetName()
          Get permission set name for action.
 java.lang.String getPrivilegeName()
          Privielge name will be returned for given action .
 java.util.Map<java.lang.String,ProfileActionObject> getProfileActionObjectMap()
          Gets the map of Object Name and ProfileActionObject.
 java.util.List<ProfileActionObject> getProfileActionObjects()
          Gets the Profile Action Object list .(Will be used for action type PROFILE).
 boolean isIsFSOnly()
          Returns the value for FSOnly flag.(Primarliy for type OBJECT only)
 void setMenuId(java.lang.Long menuId)
          Setter for menu Id.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getProfileActionObjects

public java.util.List<ProfileActionObject> getProfileActionObjects()
Gets the Profile Action Object list .(Will be used for action type PROFILE).

Returns:
List of ProfileActionObject
See Also:
ProfileActionObject

getProfileActionObjectMap

public java.util.Map<java.lang.String,ProfileActionObject> getProfileActionObjectMap()
Gets the map of Object Name and ProfileActionObject. (Will be used for action type PROFILE).

Returns:
Map of object Name,ProfileActionObject
See Also:
ProfileActionObject

getActionMapForProfileUI

public static ActionMap getActionMapForProfileUI(java.lang.String actionDisplay,
                                                 java.util.List<ProfileActionObject> profileActionObjects)
This api is to be used in conjunction with the Profile UI. The taskflow for profile UI requires list of actions to be passed as a parameter, each element in this list is an ActionMap and inorder to get an instance of ActionMap with desired properties that are relevant to the Profile UI, this api can be used with appropriate values passed in for the desired properties that are relevant for the Profile UI. The properties that are desirable for an action (ActionMap) in the Profile UI are as below:

Parameters:
actionDisplay - : display name of the action to be shown in the UI.
profileActionObjects - :List of Profile Specifc Object Details
Returns:
: an instance of ActionMap with above properties set to the passed in values.
See Also:
ProfileActionObject

getActionMapForInstanceUI

public static ActionMap getActionMapForInstanceUI(java.lang.String actionDisplay,
                                                  java.lang.String aggregatePrivilegeName)
This api is to be used in conjunction with the instance level UI. The taskflow for instance level UI requires list of actions to be passed as a parameter, each element in this list is an ActionMap and inorder to get an instance of ActionMap with desired properties that are relevant to the instance level UI, this api can be used with appropriate values passed in for the desired properties that are relevant for the instance level UI. The properties that are desirable for an action (ActionMap) in the instance level UI are as below:

Parameters:
actionDisplay - : display name of the action to be shown in the UI.
aggregatePrivilegeName - : menu name as per the FND_MENUS table
Returns:
: an instance of ActionMap with above properties set to the passed in values.

getActionMapForObjectUI

public static ActionMap getActionMapForObjectUI(java.lang.String actionDisplay,
                                                java.lang.String aggregatePrivilegeName,
                                                java.lang.String permissionSetName,
                                                boolean isFSOnly,
                                                java.util.List<java.lang.String> instanceSetNames)
This api is to be used in conjunction with the Object level UI. The taskflow for Object level UI requires list of actions to be passed as a parameter, each element in this list is an ActionMap and inorder to get an instance of ActionMap with desired properties that are relevant to the Object level UI, this api can be used with appropriate values passed in for the desired properties that are relevant for the Object level UI. The properties that are desirable for an action (ActionMap) in the Object level UI are as below:

Parameters:
actionDisplay - : display name of the action to be shown in the UI.
aggregatePrivilegeName - : menu name as per the FND_MENUS table
permissionSetName - : name of the permission set in the policy store
isFSOnly - : determines whether the action is applicable for function security only
instanceSetNames - : the list of instance sets for which the action is applicable and a checkbox is required to be shown in the child table (instance sets table) of the Object level UI.
Returns:
: an instance of ActionMap with above properties set to the passed in values.

getAction

public java.lang.String getAction()
Get Action Display Name.

Returns:
String as action display name

getActionType

public ActionMap.ACTION_TYPE getActionType()
Get Type of the Action Map.

Returns:
ActionType

getPrivilegeName

public java.lang.String getPrivilegeName()
Privielge name will be returned for given action . (for type OBJECT and INSTANCE Only)

Returns:
privilege name

getPermissionSetName

public java.lang.String getPermissionSetName()
Get permission set name for action. (for type OBJECT Only)

Returns:
permission set name

isIsFSOnly

public boolean isIsFSOnly()
Returns the value for FSOnly flag.(Primarliy for type OBJECT only)

Returns:
ture if action is FSOnly

getInstanceSetNames

public java.util.List<java.lang.String> getInstanceSetNames()
Gets the instance set Name.(for type OBJECT only)

Returns:
instance names list applicable to given action.

setMenuId

public void setMenuId(java.lang.Long menuId)
Setter for menu Id. (used for internal validation)

Parameters:
menuId - Long

getMenuId

public java.lang.Long getMenuId()
Getter for menu ID (used for internal validation).

Returns:
menu Id as Long

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.