FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface ContainableObject

All Superinterfaces:
BaseObject, java.io.Serializable, ValueObject
All Known Subinterfaces:
CustomObject, Document, Document, PublishRequest, PublishTemplate, StoredSearch, StyleTemplate, WorkflowDefinition

public interface ContainableObject
extends BaseObject

An object implementing the ContainableObject interface is an object that can be referentially-contained in a folder. Note that Folder objects are not containable, as a folder is directly-contained within another folder. In this release of the CS Java Connector, only Document objects are containable.

See Also:
CS Java Toolkit Developer's Guide

Field Summary
static java.lang.String INVALID_CONTAINMENT_NAME_CHARACTERS
          

Implemented but not used in the Content Services Java Connector

 
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
 java.lang.String file(Folder destinationFolder, boolean resolveUniqueness)
          Files this ContainableObject object into the specified folder.
 java.lang.String file(Folder destinationFolder, boolean resolveUniqueness, java.lang.String containmentName)
          Files this ContainableObject object into the specified folder.
 Folders getContainers()
          Returns the folders, if any, that this ContainableObject object is filed in.
 java.lang.String getContainersXML(java.lang.String[] propNames)
          Returns a string in XML that represents any folders (and their requested properties) that this ContainableObject object is filed in.
 java.lang.String[] getContainmentNames(Folder folder)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String[] getContainmentPaths()
          Returns an array of strings that represent containment full paths, including the containment name associated with this ContainableObject object.
 Folder getSecurityParent()
          

Not Implemented in CS Java Connector v3.0.

 void setContainmentName(Folder folder, java.lang.String containmentName)
          

Not Implemented in CS Java Connector v3.0.

 void setContainmentName(Folder folder, java.lang.String containmentName, java.lang.String targetContainmentName)
          

Not Implemented in CS Java Connector v3.0.

 void setSecurityParent(Folder folder)
          

Not Implemented in CS Java Connector v3.0.

 void unfile(Folder removeFolder)
          Removes this ContainableObject object from the specified folder.
 void unfile(Folder removeFolder, java.lang.String targetContainmentName)
          Removes this ContainableObject object from the specified folder.
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 

Field Detail

INVALID_CONTAINMENT_NAME_CHARACTERS

public static final java.lang.String INVALID_CONTAINMENT_NAME_CHARACTERS

Implemented but not used in the Content Services Java Connector

See Also:
Constant Field Values
Method Detail

getContainers

public Folders getContainers()
Returns the folders, if any, that this ContainableObject object is filed in.

Returns:
A Folders collection containing any folders into which this ContainableObject object is filed.

getContainersXML

public java.lang.String getContainersXML(java.lang.String[] propNames)
Returns a string in XML that represents any folders (and their requested properties) that this ContainableObject object is filed in. If the propNames parameter is null or an empty array, this method returns all properties for the folders. If the array includes properties that do not exist for the folders, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of the properties to retrieve. If null or an empty array, retrieves all properties. However, if you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.

Returns:
A String containing an XML representation of the folders, if any, into which this ContainableObject object is filed.

file

public java.lang.String file(Folder destinationFolder,
                             boolean resolveUniqueness)
Files this ContainableObject object into the specified folder. If the object being filed is a Document object, the document must be checked in.

When you file an object into a folder, the Content Services sets the containment name to the object's Name property. If Name is blank, the containment name is set to the object's ID property. If setting the containment name to the object's ID property results in a duplicate containment name within the folder, the Content Services server will modify it to achieve uniqueness.

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

The following properties are removed from cache for the destination folder:

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

Parameters:
destinationFolder - The Folder object into which this ContainableObject object will be filed.

resolveUniqueness - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
No return from Content Services.


file

public java.lang.String file(Folder destinationFolder,
                             boolean resolveUniqueness,
                             java.lang.String containmentName)
Files this ContainableObject object into the specified folder. Because the resolveUniqueness and containmentName values are ignored by the CS Java Connector, this method functions the same as file(destinationFolder, resolveUniqueness).

Parameters:
destinationFolder - The Folder object into which this ContainableObject object will be filed.

resolveUniqueness - Requires a boolean value; however, the value is ignored by the CS Java Connector.

containmentName - Requires a String value; however, the value is ignored by the CS Java Connector.

Returns:
No return from Content Services.


unfile

public void unfile(Folder removeFolder)
Removes this ContainableObject object from the specified folder.

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

The following properties are removed from cache for the Folder object specified in removeFolder:

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

Parameters:
removeFolder - The Folder object from which this ContainableObject object is removed.

unfile

public void unfile(Folder removeFolder,
                   java.lang.String targetContainmentName)
Removes this ContainableObject object from the specified folder.

Because the targetContainmentName value is ignored by the CS Java Connector, this method functions the same as unfile(removeFolder).

Parameters:
removeFolder - The Folder object from which this ContainableObject object is removed.

targetContainmentName - Requires a String value; however, the value is ignored by the CS Java Connector.

getContainmentPaths

public java.lang.String[] getContainmentPaths()
Returns an array of strings that represent containment full paths, including the containment name associated with this ContainableObject object. If this ContainableObject object is filed more than once in the same folder, then each occurrence is returned as a string representing the full path including the containment name.

Returns:
An array of Strings that represent containment paths for this ContainableObject object.


setContainmentName

public void setContainmentName(Folder folder,
                               java.lang.String containmentName)

Not Implemented in CS Java Connector v3.0.

Sets the containment name for this ContainableObject object in the specified folder. This method throws an exception if containmentName includes any of the following characters: \ / : * ? " < > |

If you have this ContainableObject object filed more than once in the folder, use the setContainmentName(folder, containmentName, targetContainmentName) form of this method to specify which occurrence of the object's containment name to set.

Parameters:
folder - A Folder object into which this ContainableObject object is filed.

containmentName - A String that specifies the containment name to set; it must not be an empty string; the following characters are not allowed: \ / : * ? " < > |


setContainmentName

public void setContainmentName(Folder folder,
                               java.lang.String containmentName,
                               java.lang.String targetContainmentName)

Not Implemented in CS Java Connector v3.0.

Sets the containment name for the specified occurrence of this ContainableObject object in the specified folder. Use this form of the setContainmentName method when you have this ContainableObject object filed more than once in the folder, as this method allows you to specify which occurrence to set in the targetContainmentName parameter. If targetContainmentName is null and you have more than one occurrence of this ContainableObject object filed in the folder, then this method sets the containment name for one occurrence of the object (but which occurrence's name is set is unpredictable). This is the same as calling the setContainmentName(folder, containmentName) form of this method.

This method throws an exception if containmentName includes any of the following characters: \ / : * ? " < > |

Parameters:
folder - A Folder object into which this ContainableObject object is filed.

containmentName - A String that specifies the containment name to set; it must not be an empty string; the following characters are not allowed: \ / : * ? " < > |

targetContainmentName - A String that specifies the containment name to change. If null, the containment name for one occurrence is changed.


getContainmentNames

public java.lang.String[] getContainmentNames(Folder folder)

Not Implemented in CS Java Connector v3.0.

Returns an array of containment names for this ContainableObject object. If you have this ContainableObject object filed more than once in the specified folder, then this method returns the containment names for all occurrences of the object in the folder.

Parameters:
folder - A Folder object into which this ContainableObject object is filed.

Returns:
An array of Strings, where each String specifies a containment name.


setSecurityParent

public void setSecurityParent(Folder folder)

Not Implemented in CS Java Connector v3.0.

Specifies the folder to use as the security parent for this ContainableObject object. If this ContainableObject object is not filed into the specified folder, then this method also files the object into the specified folder. If this ContainableObject object already has a security parent, then the existing security parent is replaced by the security parent specified in the folder parameter. However, the ContainableObject object remains filed in the original security parent folder. To remove the security parent for this ContainableObject object, pass in null to the folder parameter.

Parameters:
folder - The Folder object to use as the security parent for this ContainableObject object. If null, removes the security parent for this ContainableObject object.

getSecurityParent

public Folder getSecurityParent()

Not Implemented in CS Java Connector v3.0.

Returns the folder that is the security parent for this ContainableObject object. If this ContainableObject object does not have a security parent, this method returns null.

Returns:
folder The Folder object that is the security parent for this ContainableObject object. Null if this ContainableObject object has no security parent.

FileNet Content Services
Java Connector v3.0