FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface ReadableSecurityObject

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

public interface ReadableSecurityObject
extends ReadableMetadataObject

An object implementing the ReadableSecurityObject interface is an object for which security information (permissions) can be examined. (This implies the ability to examine properties via the ReadableMetadataObject interface.)

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
 Permissions getPermissions()
          Retrieves a collection containing Permission objects for the object implementing the ReadableSecurityObject interface.
 Permissions getPermissions(java.lang.String collectionType)
          

Not Implemented in CS Java Connector v3.0.

 
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
 

Method Detail

getPermissions

public Permissions getPermissions()
Retrieves a collection containing Permission objects for the object implementing the ReadableSecurityObject interface. The user must have Read permission on the object's security ( Permission.IdmAccessViewer or higher) to retrieve the object's permissions.

Returns:
A Permissions collection containing all the Permission elements for this object.

getPermissions

public Permissions getPermissions(java.lang.String collectionType)

Not Implemented in CS Java Connector v3.0.

Retrieves permissions of the specified type for the object implementing the ReadableSecurityObject interface. The user must have Read permission on the object's security (either Permission.LEVEL_VIEW or Permission.RIGHT_READ_ACL) to retrieve the object's permissions.

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

Parameters:
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.

Returns:
A Permissions collection of the specified type containing the permissions for this object.

FileNet Content Services
Java Connector v3.0