|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Field Summary | |
static java.lang.String |
INVALID_CONTAINMENT_NAME_CHARACTERS
Implemented but not used in the Content Services Java Connector |
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 |
public static final java.lang.String INVALID_CONTAINMENT_NAME_CHARACTERS
Implemented but not used in the Content Services Java Connector
Method Detail |
public Folders getContainers()
ContainableObject
object is filed in.
Folders
collection containing any folders into
which this ContainableObject
object is filed.public java.lang.String getContainersXML(java.lang.String[] propNames)
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).
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.
ContainableObject
object is filed.public java.lang.String file(Folder destinationFolder, boolean resolveUniqueness)
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.
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.
public java.lang.String file(Folder destinationFolder, boolean resolveUniqueness, java.lang.String containmentName)
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)
.
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.
public void unfile(Folder removeFolder)
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.
removeFolder
- The Folder
object from which this
ContainableObject
object is removed.public void unfile(Folder removeFolder, java.lang.String targetContainmentName)
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)
.
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.public java.lang.String[] getContainmentPaths()
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.
ContainableObject
object.
public void setContainmentName(Folder folder, java.lang.String containmentName)
Not Implemented in CS Java Connector v3.0.
Sets the containment name for thisContainableObject
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.
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: \ / : * ? " < > |
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 thisContainableObject
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: \ / : * ? " < > |
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.
public java.lang.String[] getContainmentNames(Folder folder)
Not Implemented in CS Java Connector v3.0.
Returns an array of containment names for thisContainableObject
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.
folder
- A Folder
object into which this ContainableObject
object
is filed.
public void setSecurityParent(Folder folder)
Not Implemented in CS Java Connector v3.0.
Specifies the folder to use as the security parent for thisContainableObject
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.
folder
- The Folder
object to use as the security parent
for this ContainableObject
object. If null
,
removes the security parent for this ContainableObject
object.public Folder getSecurityParent()
Not Implemented in CS Java Connector v3.0.
Returns the folder that is the security parent for thisContainableObject
object. If this ContainableObject
object does not have a security
parent, this method returns null
.
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 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |