com.filenet.api.security

Interface Group

  • All Superinterfaces:
    EngineObject, IndependentObject, SecurityPrincipal, java.io.Serializable

    public interface Group
extends SecurityPrincipal
    Represents a group of user accounts defined by the directory service on the Content Engine server. Access rights and permissions are assigned to a grantee, which can be a user or a group. Access rights can be assigned to a group regardless of whether the group has any members. Users can be added to the group later. When a user is added to a group, the user automatically gains the access rights assigned to the group to which it belongs. A group can also have subgroups.

    Security on objects, such as folders and documents, can pertain to particular groups. These groups, and the users and subgroups that make up the group's membership, are defined and created using tools provided by your directory service product (for example, Windows Active Directory, Novell eDirectory, or Oracle Directory Server). Creating user accounts and the groups to which they belong are administrative tasks (typically performed by a system administrator) that are outside the scope of the Content Engine API.

    You cannot create a new Group object, but you can instantiate one that has been persisted in your directory service by:

    • Calling getInstance or fetchInstance on the Factory.Group class.
    • Retrieving an individual Group object from a GroupSet collection object.

    You can call methods on the Group object to retrieve information about the group, such as its name and ID, or to get references to other objects. References to other objects may include the users who are members of the group and the subgroups or parent groups of the group.

    Metadata

    Auditable: false
    AllowsInstances: false
    AllowsSubClasses: false
    ClassDefinitionName: None
    IsDependent: false
    IsHidden: false
    Searchable: false
    StorageType: Domain
    SuperclassName: SecurityPrincipal

    • Method Detail

      • get_Name

        java.lang.String get_Name()
        Returns the value of the Name property. For more information, see Name Property.

      • get_Id

        java.lang.String get_Id()
        Returns the value of the Id property. For more information, see Id Property.

      • get_Users

        UserSet get_Users()
        Returns the value of the Users property. For more information, see Users Property.

      • get_Groups

        GroupSet get_Groups()
        Returns the value of the Groups property. For more information, see Groups Property.

      • get_DisplayName

        java.lang.String get_DisplayName()
        Returns the value of the DisplayName property. For more information, see DisplayName Property.

      • get_DistinguishedName

        java.lang.String get_DistinguishedName()
        Returns the value of the DistinguishedName property. For more information, see DistinguishedName Property.

      • get_ShortName

        java.lang.String get_ShortName()
        Returns the value of the ShortName property. For more information, see ShortName Property.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2015. All rights reserved.