Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.beans
Class PermissionBundle

    java.lang.Object

      |

      +--oracle.ifs.beans.LibraryObject

            |

            +--oracle.ifs.beans.TieLibraryObject

                  |

                  +--oracle.ifs.beans.SystemObject

                        |

                        +--oracle.ifs.beans.TieSystemObject

                              |

                              +--oracle.ifs.beans.PermissionBundle

All Implemented Interfaces:
  IfsEventHandler, LibraryObjectInterface, SystemObjectInterface, Traceable

Direct Known Subclasses:
  TiePermissionBundle

public class PermissionBundle
extends TieSystemObject

The PermissionBundle class lets users group multiple access levels into a customized bundle.
The main purpose of this class is to provide convenience over having to use each access level separately. This object can also act as a "Role" in that when this bundle is updated all ACLs automatically reflect the change.

See Also:
  `AccessLevel`

Field Summary
`static java.lang.String` | `ACCESSLEVEL_ATTRIBUTE` The level of the permission represented by this PermissionBundle (e.g.
`static java.lang.String` | `CLASS_NAME` The name of this class.
`static java.lang.String` | `DESCRIPTION_ATTRIBUTE` A textual description of the PermissionBundle.
`static java.lang.String` | `EXTENDEDPERMISSIONS_ATTRIBUTE` The extended permission levels created by a custom application which are associated with this PermissionBundle.
`static java.lang.String` | `NAME_ATTRIBUTE` The name of the PermissionBundle.

Fields inherited from class oracle.ifs.beans.SystemObject
`ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE`

Method Summary
`AccessLevel` | `getAccessLevel()` Returns the access level represented by this ACE
`java.lang.String` | `getDescription()` Returns description of this object
`void` | `setAccessLevel(AccessLevel al)` Sets the access level.
`void` | `setDescription(java.lang.String description)` Update the description of this object.

Methods inherited from class oracle.ifs.beans.SystemObject
`getPolicyBundle, getPropertyBundle, isActive, putPolicy, putProperty, putProperty, removeAllPolicies, removeAllProperties, removePolicy, removePolicy, removeProperty, setActive, setPolicyBundle, setPropertyBundle`

Methods inherited from class oracle.ifs.beans.LibraryObject
`equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getName, getSession, handleEvent, hasNameAttribute, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update`

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface
`getId`

Methods inherited from interface oracle.ifs.common.Traceable
`getTraceLogger, isTraced, trace`

Field Detail

### CLASS_NAME

    public static final java.lang.String CLASS_NAME

  The name of this class. Useful for methods that take a class name argument.

### NAME_ATTRIBUTE

    public static final java.lang.String NAME_ATTRIBUTE

  The name of the PermissionBundle.

### DESCRIPTION_ATTRIBUTE

    public static final java.lang.String DESCRIPTION_ATTRIBUTE

  A textual description of the PermissionBundle.

### ACCESSLEVEL_ATTRIBUTE

    public static final java.lang.String ACCESSLEVEL_ATTRIBUTE

  The level of the permission represented by this PermissionBundle (e.g. Discover, Delete).

### EXTENDEDPERMISSIONS_ATTRIBUTE

    public static final java.lang.String EXTENDEDPERMISSIONS_ATTRIBUTE

  The extended permission levels created by a custom application which are associated with this PermissionBundle.

Method Detail

### getDescription

    public java.lang.String getDescription()
                                    throws IfsException

  Returns description of this object
  Returns:
    The object description
  Throws:
    `IfsException` - if operation fails.

### setDescription

    public void setDescription(java.lang.String description)
                        throws IfsException

  Update the description of this object.
  Parameters:
    `description` - New description
  Throws:
    `IfsException` - if operation fails.

### getAccessLevel

    public AccessLevel getAccessLevel()
                               throws IfsException

  Returns the access level represented by this ACE
  Returns:
    the access level represented by this ACE
  Throws:
    `IfsException` - if operation fails.

### setAccessLevel

    public void setAccessLevel(AccessLevel al)
                        throws IfsException

  Sets the access level.
  Parameters:
    `the` - desired access level fort his PermissionBundle
  Throws:
    `IfsException` - if operation fails.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD