FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface Group

All Superinterfaces:
BaseObject, ReadableMetadataObject, SecurityGrantee, java.io.Serializable, ValueObject

public interface Group
extends BaseObject, SecurityGrantee, ReadableMetadataObject

A Group object reflects a set of user accounts defined on the Content Services server. Access rights are assigned to individual user accounts and/or to the groups to which the individual user belongs.

Security on objects, such as folders and documents, can pertain to particular groups. These groups, and the users that make up the group's membership, are defined by the Content Services system administrator.

You cannot create a new Group object, but you can instantiate a persisted one by retrieving an individual Group object from a Groups collection object. (Refer to the Groups interface for ways to instantiate this collection object.)

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

A copy of users and groups are cached.

See Also:
CS Java Toolkit Developer's Guide

Field Summary
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
Method Summary
 Groups getSubGroups()
          

Not Implemented in CS Java Connector v3.0.

 Users getUsers()
          Returns a Users collection object whose elements represent the user accounts in this group.
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 
Methods inherited from interface com.filenet.wcm.api.SecurityGrantee
getParentGroups, getParentGroups
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 

Method Detail

getSubGroups

public Groups getSubGroups()

Not Implemented in CS Java Connector v3.0.

Returns a Groups collection whose elements represent members of this Group.

A group can identify a set of users as well as other groups, called subgroups. Use this method to retrieve the subgroups of this Group.

Returns:
A Groups collection.

getUsers

public Users getUsers()

Returns a Users collection object whose elements represent the user accounts in this group. For example, a system administrator might assign all users in the Accounting department to a group called "Acctg". A call to getUsers() on that group returns a list of the users who are members of the "Acctg" group.

Each user assigned to the group has the same access rights that are assigned to the group, except when a user's rights are higher than the group's. In that case, the user's rights take precedence.

Returns:
A Users collection. Each element of the collection represents a user assigned to this Group.

FileNet Content Services
Java Connector v3.0