FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface WriteableSecurityObject

All Superinterfaces:
BaseObject, ReadableMetadataObject, ReadableSecurityObject, java.io.Serializable, ValueObject, WriteableMetadataObject
All Known Subinterfaces:
Annotation, CustomObject, Document, Document, EventAction, Folder, Folder, Link, PublishRequest, PublishTemplate, SecurityPolicy, StoredSearch, StyleTemplate, Subscription, WorkflowDefinition, WorkflowSubscription

public interface WriteableSecurityObject
extends WriteableMetadataObject, ReadableSecurityObject

An object implementing the WriteableSecurityObject interface is an object for which security information (permissions) can be changed and persisted to the object store. (This implies the ability to change and persist properties via the WriteableMetadataObject interface.)

See Also:
CS Java Connector 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
 void setPermissions(Permissions aclCollection)
          Sets permissions for the object implementing this WriteableSecurityObject interface and persists them to the Content Services object store (library).
 void setPermissions(Permissions perms, java.lang.String collectionType)
          

Not Implemented in CS Java Connector v3.0.

 
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject
setProperties
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 
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.ReadableSecurityObject
getPermissions, getPermissions
 

Method Detail

setPermissions

public void setPermissions(Permissions aclCollection)
Sets permissions for the object implementing this WriteableSecurityObject interface and persists them to the Content Services object store (library). The user must have Permission.idmAccessOwner access on this object to set its permissions.

Because setPermissions completely replaces the collection, note that you must set the entire Permissions collection, including those Permission elements whose values remain unchanged. Your collection should contain at least one element. Passing in an empty collection removes all access to the object; no error is thrown. To set default permissions for the object, pass in Java null for the aclCollection parameter.

After a successful call to setPermissions, the following properties are considered stale and are removed from cache for this WriteableSecurityObject object:

A subsequent request for any of these properties causes the CS Java Connector to retrieve fresh data from the Content Services server.

Parameters:
aclCollection - A Permissions collection containing the Permission objects to persist to the Content Services object store. To set default permissions, pass in Java null.

setPermissions

public void setPermissions(Permissions perms,
                           java.lang.String collectionType)

Not Implemented in CS Java Connector v3.0.

Sets permissions of the specified type for the object implementing this WriteableSecurityObject interface and persists them to the Content Services object store. The user must have Permission.LEVEL_FULL_CONTROL access on this object to set its permissions.

Specify the type of permissions (basic object or audit) to set in the collectionType parameter.

Because setPermissions completely replaces the existing permissions for the object, you must set each element in the Permissions collection, including those elements whose values remain unchanged. Your collection should contain at least one element. Passing in an empty collection removes all access to the object; no error is thrown.

When changing security on a folder, note that the change can affect the security on objects contained within the folder.

Parameters:
perms - A Permissions collection containing the Permission objects to persist to the Content Services object store. If null, throws IllegalArgumentException.

collectionType - A String that is the name of a property whose value is a collection of Content Services Permission objects. Use Property.PERMISSIONS or Property.AUDIT_PERMISSIONS for basic object or audit permissions, respectively.

FileNet Content Services
Java Connector v3.0