blob: 2d36e1f729da10706307088b094217e87cedd9db [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Mon Apr 06 12:58:11 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Folder (Apache Chemistry OpenCMIS 0.13.0 API)</title>
<meta name="date" content="2015-04-06">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Folder (Apache Chemistry OpenCMIS 0.13.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Folder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Item.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html" target="_top">Frames</a></li>
<li><a href="Folder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.chemistry.opencmis.inmemory.storedobj.api</div>
<h2 title="Interface Folder" class="title">Interface Folder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Fileable.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Fileable</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Filing</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">StoredObject</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/FolderImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">FolderImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Folder</span>
extends <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Fileable.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Fileable</a></pre>
<div class="block">A folder is a concrete object (meaning it can be stored) and has Each folder
is contained in a parent folder. The parent folder for the special root
folder is null.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.chemistry.opencmis.inmemory.storedobj.api.Filing">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.chemistry.opencmis.inmemory.storedobj.api.<a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Filing</a></h3>
<code><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#PATH_SEPARATOR">PATH_SEPARATOR</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html#getAllowedChildObjectTypeIds()">getAllowedChildObjectTypeIds</a></strong>()</code>
<div class="block">return a list of allowed types of children in this folder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html#getParentId()">getParentId</a></strong>()</code>
<div class="block">get parent if of this folder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html#setParentId(java.lang.String)">setParentId</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parentId)</code>
<div class="block">set the parent id of a folder.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.inmemory.storedobj.api.StoredObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.chemistry.opencmis.inmemory.storedobj.api.<a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">StoredObject</a></h3>
<code><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#addAppliedPolicy(java.lang.String)">addAppliedPolicy</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#createSystemBasePropertiesWhenCreated(java.util.Map, java.lang.String)">createSystemBasePropertiesWhenCreated</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#fillProperties(java.util.Map, org.apache.chemistry.opencmis.commons.spi.BindingsObjectFactory, java.util.List)">fillProperties</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getAclId()">getAclId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getAllowableActions(java.lang.String)">getAllowableActions</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getAppliedPolicies()">getAppliedPolicies</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getChangeToken()">getChangeToken</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getCreatedAt()">getCreatedAt</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getCreatedBy()">getCreatedBy</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getDescription()">getDescription</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getId()">getId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getModifiedAt()">getModifiedAt</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getModifiedBy()">getModifiedBy</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getName()">getName</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getProperties()">getProperties</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getRepositoryId()">getRepositoryId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getSecondaryTypeIds()">getSecondaryTypeIds</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#getTypeId()">getTypeId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#hasRendition(java.lang.String)">hasRendition</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#removePolicy(java.lang.String)">removePolicy</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setCreatedAt(java.util.GregorianCalendar)">setCreatedAt</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setCreatedBy(java.lang.String)">setCreatedBy</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setCustomProperties(java.util.Map)">setCustomProperties</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setId(java.lang.String)">setId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setModifiedAt(java.util.GregorianCalendar)">setModifiedAt</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setModifiedAtNow()">setModifiedAtNow</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setModifiedBy(java.lang.String)">setModifiedBy</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setName(java.lang.String)">setName</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setProperties(java.util.Map)">setProperties</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setRepositoryId(java.lang.String)">setRepositoryId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#setTypeId(java.lang.String)">setTypeId</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html#updateSystemBasePropertiesWhenModified(java.util.Map, java.lang.String)">updateSystemBasePropertiesWhenModified</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.inmemory.storedobj.api.Filing">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.chemistry.opencmis.inmemory.storedobj.api.<a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Filing</a></h3>
<code><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#getParentIds()">getParentIds</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#getPathSegment()">getPathSegment</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#hasParent()">hasParent</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getParentId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentId</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getParentId()</pre>
<div class="block">get parent if of this folder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>parent id of this folder</dd></dl>
</li>
</ul>
<a name="setParentId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParentId</h4>
<pre>void&nbsp;setParentId(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parentId)</pre>
<div class="block">set the parent id of a folder.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parentId</code> - parent id of this folder</dd></dl>
</li>
</ul>
<a name="getAllowedChildObjectTypeIds()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAllowedChildObjectTypeIds</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getAllowedChildObjectTypeIds()</pre>
<div class="block">return a list of allowed types of children in this folder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>list of allowed object child type ids</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Folder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Item.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html" target="_top">Frames</a></li>
<li><a href="Folder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2009-2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>