mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
27600: ALF-8522: MyBatis: Performance: ensure <association> elements are properly keyed 27608: RINF 09 / RINF 10: DB-based paged query for get children (DocLib & CMIS) - update FileFolder paging API - update GetChildren canned query sorting (to return sort props prior to batched pre-load) 27614: RINF 09 / RINF 10: DB-based paged query for get children (DocLib & CMIS) - add missing file (and fix my SmartSVN ignore unversioned list ;-) - follow-on to r27608 27621: RINF 11: Extended generalized CannedQueryDAO to support common selects - MyBatis resultset termination included - RINF 11: Integrate existing CannedQueryDAO (ALF-8417) - RINF 11: Canned queries (ALF-7167) 27623: RINF 09 / RINF 10: DB-based paged query for get children (DocLib & CMIS) - if total count not requested then can cut-off permission checks (based on max items) and instead set "hasMore" flag (if applicable) - now used by Share DocLib folder tree listing (on LHS) - see ALF-6570 27636: RINF 09 / RINF 10: DB-based getChildren - improvements to treenode (push down sort by name, get subfolders with max 1, remove redundant max check) - re: ALF-6570 - add default child assoc sort (if no sort requested) - minor tweak to getChildren CQ trace logging 27641: RINF 11: Extended generalized CannedQueryDAO - add temporary MyBatis workarounds for ResultHandler-based queries --> support unlimited queries for nested results maps (MyBatis #129) --> clear cache to return results on subsequent calls (MyBatis #58 ...) 27642: RINF 16: Ordered associations: Added NodeService.setAssociations - All reordering, deleting and adding node by NodeService impl. - ALF-7405 (ALF-7404 RINF 16: Peer association enhancements) 27643: ALF-8183 SVC 01: I18N List of values constraint. Added ListOfValuesConstraint.getDisplayLabel(constraintAllowableValue) method which uses the usual I18NUtil methods to retrieve a localised display-label for the LoV constraint values. These can be added to resource bundles in the usual way using a key as follows: listconstraint.test_list1.ABC=ABC display where "listconstraint." is a fixed prefix. "test_list1" is the shortform QName for the constraint with colon replaced by underscore. "ABC" is one of the allowed values for the named constraint. The test case changes & the associated model & property changes should make things clear. 27644: Test cases for ChannelService.createChannel and ChannelService.getChannels 27645: ALF-8183. I18N LIST constraint. This check-in ensures that requests for a LIST.value display label for: a non-existent value returns null an unlocalised value returns the allowableValue String from the model (backwards compatibility). 27651: Fixing compile errors caused by moving NodeLocator classes. 27652: RINF 09 / RINF 10: DB-based getChildren CQ - replace direct use of "sqlSessionTemplate" with "cannedQueryDAO"(RINF 11) 27657: RINF 09: GetChildren CQ - temp fix for cm:modified (when qname does not exist) - TODO review 27666: Support for ALF-8594: RSOLR 039: SOLR sorting - sorting for all single valued types 27671: Ignore virtual tomcat build 27673: Projects core, datamodel and solr now explicitly list their library dependencies and no longer include the 3rd party project 27681: Added pub:channelInfo aspect tows:webasset and ws:section. Also ws:website now extends pub:DeliveryChannel. Added new behaviours to section and website to ensure the channel info is populated. 27682: Added example SOLR config dir and instructions on how to set up - simple dev set up only subject to lots of change 27685: Cleanup: Removed non-javadoc; Removed unused methods; Added @override 27689: Update SOLR test instance dependencies 27692: ALF-8183 SVC 01: I18N Lost of values constraint. Added code to the FormService's PropertyFieldProcessor so that the allowedValues for a ListOfValuesConstraint have both the allowed value and its localised display label, if there is one. Added English property values for the bpm:allowedStatus constraint and also for the LIST constraint in the FDK. 27693: WCM-QS ML work - Have the webscript return more details on the node and its parents, and begin to use this in the UI to allow you to create as well as manage translations 27695: Workaround/fix for ALF-5747. Incompatibilities with OpenOffice 3.3 It looks like OOo 3.3.0 shipped with a missing component. The ConfigurationRegistry, which is used to remotely query the OOo version, was not implemented in 3.3.0 and therefore gives an ugly (and unavoidable) exception on OOo startup. There's not much we can do here, beyond getting users to upgrade their OOo install. I've added a catch clause that detects this problem and emits a slightly friendlier warning to the log. 27720: ALF-8532: WPUB: F148: Foundation API: Request that a node be published to the live environment 27727: Removed duplicates 27734: WCM-QS ML Updates to handle marking a node as an initial translation, and a start on creating translations 27735: Fixed generics warning 27736: Added PermissionService.getReaders(List<Long> aclIds) - Support for ALF-8335: RSOLR 013: DAOs and remote APIs for ACL changesets (ALF-7072) - Also cleaned up empty javadoc 27739: Implemented NodeFilters and NodeFinders for AbstractChannelType and ChannelServiceImpl. 27741: RINF 09: GetChildren CQ - fix sorting - with unit tests (for default Share DocLib fields) - partial ALF-8638 - ALF-8584 (follow-on for r27657) 27746: Start on linking the WCM-QS ML ui and the forms service for creating the translation 27747: Added --INCLUDE: directive to SQL scripts to allow importing of DB-specific snippets - ALF-8498: SVC 06: Property holding comment count for a node 27748: Web scripts for ACLs and ACL readers - Unit tests at all levels (Webscripts, Service and DAO) - Tweaks to the DB queries to support index-based sorting - Support for ALF-8335: RSOLR 013: DAOs and remote APIs for ACL changesets (ALF-7072) 27753: Fixed enum naming 27754: Undo changes to ChannelServiceImplIntegratedTest made in 27739 that broke the build 27762: Part I: ALF-7992: RSOLR 024: Locale support for query: SOLR - restructure and split localisation from generic query parsing - Lucene impl migrated and tested - No SOLR impl yet - Fix CMIS QueyTest - Fix references for LuceneQueryParser mostly to AbstractLuceneQueryParser 27763: Initial implementation of ALF-8498. SVC 06: Property holding comment count for a node. This check-in adds a rollup property to hold the commentCount (fm:commentCount under fm:discussable). It adds registered behaviours for fm:post deletion/creation that will decrement/increment the commentCount for the discussable ancestor node. I've also added a new test class to test this rollup property. There was no existing test class at this level and indeed there is no CommentService or DiscussionService. Instead the REST API of comment.put.desc.xml uses the ScriptNodeService to create the correct node structure. Therefore the test code has had to do the same thing. 27766: Slight reimpl of ALF-8498. Moved the rollup property onto its own aspect. So now we have fm:discussable, as before, for generic discussions and posts (including Explorer comments). And we have fm:commentsRollup which is only for rolling up Share comments. 27777: WCM QS ML Forms config and related tweaks to support having newly created nodes made multilingual where required 27781: Add repository project dependency for test context and debug - fixes model issue with SOLRAPIClientTest 27782: SOLR - move back to dynamic catch all field which seems to be working -> simpler build and model management 27810: ALF-8405 SiteAspect needs to handle child types of Site as well as Site itself 27821: ALF-7070: Fixed SOLRSerializer to handle residual properties (not in dictionary) 27828: RINF 11: Canned Queries (CQ) - update API post review . - add underlying pageRequest/pageResult for single page (or max items if skip is 0) - add hasMoreItems (ALF-8470) and update unit tests - return total count range - accurate count (if lower=upper), approximation (lower<upper) or more than (lower known, upper unknown) - update option to request total count with max (if cutoff/trimmed then returns unknown upper count) 27829: RINF 09: GetChildren CQ - paging support for FileFolderService list - update impl wrt CQ API changes (follow-on to r27828) - add factory method to return CQ with common params & update FileFolderService - update CMIS getChildren (AlrescoCmisService) - update scripting layer (ScriptNode, ScriptPagingNodes) - update Share DocLib (including doclist & treenode) - ALF-8641 - add proto (UI subject to review) to demo Share DocLib requesting max total count (eg. "Showing items 1 - 50 of 1000++") 27837: Moving the pdfbox, fontbox, jempbox libs from 1.3.1 to 1.5.0, which adds various bugfixes. 27838: Web scripts for ACLs and ACL readers - Simplification of paging API for ACLs - Support for ALF-8335: RSOLR 013: DAOs and remote APIs for ACL changesets (ALF-7072) 27839: SOLR ACL tracking client code and tests - Support for ALF-8335: RSOLR 013: ACL changesets client APIs (ALF-8463) 27844: Build fix. Making SiteServiceImplTest more tolerant of preexisting sites. 27845: Build fix. Making SiteServiceTest more tolerant of preexisting sites in databse. 27846: Build fix relating to ALF-8183. An extra test constraint requires an increment to a assertion expectedValue in this test. 27849: ALF-8532: WPUB: F148: Foundation API: Request that a node be published to the live environment - Added more necessary interfaces and framework code 27850: RINF 09: GetChildren CQ - update sorting unit test + fixes - nulls sort 'low' - fix multi sort props 27858: ALF-8532: WPUB: F148: Foundation API: Request that a node be published to the live environment - Initial cut of persisting publishing events (not tested yet) 27861: WCM QS ML webscript work - fix some issues, and start on webscript unit test Also updates a failing test with details of why it's failing (switch from JSON to XML some time ago) 27864: Fix context minimal tests - web publishing context is already included from the high level context, and shouldn't be in the core one 27867: ALF-8184: SVC 02: Encode and decode of forms itemId should be done in the REST layer and not in each individual form processor. 27868: Sample Adobe Illustrator files from Linton, for use in testing future metadata/transformer support 27869: Fixed ChannelServiceImplTest failures. 27870: Created JBPM process definition to publish scheduled Publishing Events. 27872: Sample Adobe Illustrator 3 file (PS not PDF based) from Linton, for use in testing future metadata/transformer support 27874: OpenCMIS update 27875: Change the Tika auto transformer to register aliases of mime types, as well as the canonical ones, for when Alfresco uses the alias 27876: RINF 11: Permission checking in canned queries (ALF-8419) 27877: RINF 39: Optimise GetChildren CQ for unsorted maxItems (ALF-8576) 27878: RINF 09: Update FileFolderService - all list methods should use GetChildren CQ (ALF-8733) 27882: ALF-8532: WPUB: F148: Foundation API: Request that a node be published to the live environment - Unit test for the publishing package serializer/deserializer 27885: Change order of publishing context so it comes after transfer service context. 27886: Fix for ALF-7992: RSOLR 024: Locale support for query: SOLR - d:mltext, d:text. d:content - phrase, term, prefix, wild, ranges, fuzzy etc - localised tokenisation - consistent tokenisation for cross language support ( phrase, term, prefix, wild, ranges, fuzzy etc) - CMIS related stuff to be tested later 27897: Minor tweak to prevent repeated gets of the default locale when writing properties 27900: WCM QS ML webscript tests 27905: Fixed PostgreSQL HeartbeatTest: WorkflowDeployer was checking for read-only server too late 27906: Remove unused imports 27907: Used common SQL snippets for DB2 node inserts. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@28319 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
360 lines
16 KiB
Java
360 lines
16 KiB
Java
/*
|
|
* Copyright (C) 2005-2011 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.service.cmr.model;
|
|
|
|
import java.util.List;
|
|
import java.util.Set;
|
|
|
|
import org.alfresco.service.Auditable;
|
|
import org.alfresco.service.PublicService;
|
|
import org.alfresco.service.cmr.repository.ContentReader;
|
|
import org.alfresco.service.cmr.repository.ContentWriter;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.springframework.extensions.surf.util.I18NUtil;
|
|
|
|
/**
|
|
* Provides methods specific to manipulating {@link org.alfresco.model.ContentModel#TYPE_CONTENT files}
|
|
* and {@link org.alfresco.model.ContentModel#TYPE_FOLDER folders}.
|
|
*
|
|
* So this interface provides a simple way of accessing simple trees of files and folders in Alfresco.
|
|
*
|
|
* @see org.alfresco.model.ContentModel
|
|
*
|
|
* @author Derek Hulley
|
|
*/
|
|
@PublicService
|
|
public interface FileFolderService
|
|
{
|
|
/**
|
|
* Lists immediate child files and folders of the given context node
|
|
*
|
|
* @param contextNodeRef the node to start searching in
|
|
* @return Returns a list of matching files and folders
|
|
*/
|
|
@Auditable(parameters = {"contextNodeRef"})
|
|
public List<FileInfo> list(NodeRef contextNodeRef);
|
|
|
|
/**
|
|
* Lists page of immediate child files and/or folders of the given context node
|
|
*
|
|
* @author janv
|
|
* @since 4.0
|
|
*/
|
|
public PagingFileInfoResults list(NodeRef contextNodeRef,
|
|
boolean files,
|
|
boolean folders,
|
|
Set<QName> ignoreTypeQNames,
|
|
PagingFileInfoRequest pagingRequest);
|
|
|
|
/**
|
|
* Lists all immediate child files of the given context node
|
|
*
|
|
* @param folderNodeRef the folder to start searching in
|
|
* @return Returns a list of matching files
|
|
*/
|
|
@Auditable(parameters = {"folderNodeRef"})
|
|
public List<FileInfo> listFiles(NodeRef folderNodeRef);
|
|
|
|
/**
|
|
* Lists all immediate child folders of the given context node
|
|
*
|
|
* @param contextNodeRef the node to start searching in
|
|
* @return Returns a list of matching folders
|
|
*/
|
|
@Auditable(parameters = {"contextNodeRef"})
|
|
public List<FileInfo> listFolders(NodeRef contextNodeRef);
|
|
|
|
/**
|
|
* Lists all folders below the given context node, both immediate and lower levels
|
|
*
|
|
* The filter parameter allows subfolders to be excluded from the search.
|
|
*
|
|
* @param contextNodeRef the node to start searching in
|
|
* @param filter - may be null in which case all sub-folders will be searched
|
|
*/
|
|
@Auditable(parameters = {"contextNodeRef"})
|
|
public List<FileInfo> listDeepFolders(NodeRef contextNodeRef, SubFolderFilter filter);
|
|
|
|
/**
|
|
* Uses the <b>cm:name</b> of the given node and attempts to find a sibling node
|
|
* with a more specific localized name. The node passed in must represent the base
|
|
* of the possible translations i.e. the base name for the resource names will be
|
|
* calculated using the filename without extension. The locale used will come from
|
|
* {@link I18NUtil#getLocale() the thread's default locale}.
|
|
*
|
|
* @param nodeRef the node that acts as the baseline for the search
|
|
* @return Returns a sibling node or the original node
|
|
*/
|
|
@Auditable(parameters = ("nodeRef"))
|
|
public NodeRef getLocalizedSibling(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get a node ref of the node that has the name within the parent node
|
|
*
|
|
* @param contextNodeRef the parent node
|
|
* @param name the name of the node to search for
|
|
* @return Returns the node that has the given name - or null if not found
|
|
*/
|
|
@Auditable(parameters = {"contextNodeRef", "name"})
|
|
public NodeRef searchSimple(NodeRef contextNodeRef, String name);
|
|
|
|
/**
|
|
* Searches for all files and folders with the matching name pattern,
|
|
* using wildcard characters <b>*</b> and <b>?</b>.
|
|
*
|
|
* Warning: Please avoid using this method with any "namePattern" other than "*".
|
|
* Although it works, its performance is poor, which is why this method is deprecated.
|
|
*
|
|
* @param contextNodeRef the context of the search. This node will never be returned
|
|
* as part of the search results.
|
|
* @param namePattern the name of the file or folder to search for, or a
|
|
* {@link org.alfresco.util.SearchLanguageConversion#DEF_LUCENE wildcard} pattern
|
|
* to search for.
|
|
* @param includeSubFolders true to search the entire hierarchy below the search context
|
|
* @return Returns a list of file or folder matches
|
|
*
|
|
* @see #search(NodeRef, String, boolean, boolean, boolean)
|
|
* @deprecated for shallow search use list, listFolders, listFiles, searchSimple.
|
|
* For deep listing use listDeepFolders.
|
|
* Avoid calling this method with any name pattern except for "*".
|
|
*/
|
|
@Auditable(parameters = {"contextNodeRef", "namePattern", "includeSubFolders"})
|
|
public List<FileInfo> search(
|
|
NodeRef contextNodeRef,
|
|
String namePattern,
|
|
boolean includeSubFolders);
|
|
|
|
/**
|
|
* Perform a search against the name of the files or folders within a hierarchy.
|
|
* Wildcard characters are <b>*</b> and <b>?</b>.
|
|
*
|
|
* Warning: Please avoid using this method with any "namePattern" other than "*".
|
|
* Although it works, its performance is poor which is why this method is deprecated.
|
|
*
|
|
* @param contextNodeRef the context of the search. This node will never be returned
|
|
* as part of the search results.
|
|
* @param namePattern the name of the file or folder to search for, or a
|
|
* {@link org.alfresco.util.SearchLanguageConversion#DEF_LUCENE wildcard} pattern
|
|
* to search for.
|
|
* @param fileSearch true if file types are to be included in the search results
|
|
* @param folderSearch true if folder types are to be included in the search results
|
|
* @param includeSubFolders true to search the entire hierarchy below the search context
|
|
* @return Returns a list of file or folder matches
|
|
* @deprecated for shallow search use list, listFolders, listFiles, searchSimple.
|
|
* For deep listing use listDeepFolders.
|
|
* Avoid calling this method with any name pattern except for "*".
|
|
*/
|
|
@Auditable(parameters = {"contextNodeRef", "namePattern", "fileSearch", "folderSearch", "includeSubFolders"})
|
|
public List<FileInfo> search(
|
|
NodeRef contextNodeRef,
|
|
String namePattern,
|
|
boolean fileSearch,
|
|
boolean folderSearch,
|
|
boolean includeSubFolders);
|
|
|
|
/**
|
|
* Rename a file or folder in its current location
|
|
*
|
|
* @param fileFolderRef the file or folder to rename
|
|
* @param newName the new name
|
|
* @return Return the new file info
|
|
* @throws FileExistsException if a file or folder with the new name already exists
|
|
* @throws FileNotFoundException the file or folder reference doesn't exist
|
|
*/
|
|
@Auditable(parameters = {"fileFolderRef", "newName"})
|
|
public FileInfo rename(NodeRef fileFolderRef, String newName) throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Move a file or folder to a new name and/or location.
|
|
* <p>
|
|
* If both the parent folder and name remain the same, then nothing is done.
|
|
*
|
|
* @param sourceNodeRef the file or folder to move
|
|
* @param targetParentRef the new parent node to move the node to - null means rename in situ
|
|
* @param newName the name to change the file or folder to - null to keep the existing name
|
|
* @return Returns the new file info
|
|
* @throws FileExistsException
|
|
* @throws FileNotFoundException
|
|
*/
|
|
@Auditable(parameters = {"sourceNodeRef", "targetParentRef", "newName"})
|
|
public FileInfo move(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName)
|
|
throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Move a file or folder to a new name and/or location.
|
|
* <p>
|
|
* If both the parent folder and name remain the same, then nothing is done.
|
|
* <p/>
|
|
* It is possible to specify <i>which</i> is the parent node when moving nodes; nodes
|
|
* can reside in multiple locations.
|
|
*
|
|
* @param sourceNodeRef the file or folder to move
|
|
* @param sourceParentRef the source parent of node - <tt>null</tt> means move from primary parent
|
|
* @param targetParentRef the new parent node to move the node to - null means rename in situ
|
|
* @param newName the name to change the file or folder to - null to keep the existing name
|
|
* @return Returns the new file info
|
|
* @throws FileExistsException
|
|
* @throws FileNotFoundException
|
|
*/
|
|
@Auditable(parameters = { "sourceNodeRef", "sourceParentRef", "targetParentRef", "newName" })
|
|
public FileInfo moveFrom(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* @deprecated From 3.4.2, use {@link #moveFrom(NodeRef, NodeRef, NodeRef, String)} or
|
|
* {@link #move(NodeRef, NodeRef, String)}. See
|
|
* <a href="https://issues.alfresco.com/jira/browse/ALF-7692">ALF-7692</a>
|
|
*/
|
|
@Auditable(parameters = { "sourceNodeRef", "sourceParentRef", "targetParentRef", "newName" })
|
|
public FileInfo move(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Copy a source file or folder. The source can be optionally renamed and optionally moved into another folder.
|
|
* <p>
|
|
* If both the parent folder and name remain the same, then nothing is done.
|
|
*
|
|
* @param sourceNodeRef the file or folder to copy
|
|
* @param targetParentRef the new parent node to copy the node to - null means rename in situ
|
|
* @param newName the new name, or null to keep the existing name.
|
|
* @return Return the new file info
|
|
* @throws FileExistsException
|
|
* @throws FileNotFoundException
|
|
*/
|
|
@Auditable(parameters = {"sourceNodeRef", "targetParentRef", "newName"})
|
|
public FileInfo copy(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName)
|
|
throws FileExistsException, FileNotFoundException;
|
|
|
|
/**
|
|
* Create a file or folder; or any valid node of type derived from file or folder.
|
|
* <p>
|
|
* The association QName for the patch defaults to <b>cm:filename</b> i.e. the
|
|
* <b>Content Model</b> namespace with the filename as the local name.
|
|
*
|
|
* @param parentNodeRef the parent node. The parent must be a valid
|
|
* {@link org.alfresco.model.ContentModel#TYPE_FOLDER folder}.
|
|
* @param name the name of the node
|
|
* @param typeQName the type to create
|
|
* @return Returns the new node's file information
|
|
* @throws FileExistsException
|
|
*
|
|
* @see {@link #create(NodeRef, String, QName, QName)}
|
|
*/
|
|
@Auditable(parameters = {"parentNodeRef", "name", "typeQName"})
|
|
public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName) throws FileExistsException;
|
|
|
|
/**
|
|
* Create a file or folder; or any valid node of type derived from file or folder
|
|
*
|
|
* @param parentNodeRef the parent node. The parent must be a valid
|
|
* {@link org.alfresco.model.ContentModel#TYPE_FOLDER folder}.
|
|
* @param name the name of the node
|
|
* @param typeQName the type to create
|
|
* @param assocQName the association QName to set for the path (may be <tt>null</tt>).
|
|
* @return Returns the new node's file information
|
|
* @throws FileExistsException
|
|
*/
|
|
@Auditable(parameters = {"parentNodeRef", "name", "typeQName"})
|
|
public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName, QName assocQName) throws FileExistsException;
|
|
|
|
/**
|
|
* Delete a file or folder
|
|
*
|
|
* @param nodeRef the node to delete
|
|
*/
|
|
@Auditable(parameters = {"nodeRef"})
|
|
public void delete(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get the file or folder names from the root down to and including the node provided.
|
|
* <ul>
|
|
* <li>The root node can be of any type and is not included in the path list.</li>
|
|
* <li>Only the primary path is considered. If the target node is not a descendant of the
|
|
* root along purely primary associations, then an exception is generated.</li>
|
|
* <li>If an invalid type is encountered along the path, then an exception is generated.</li>
|
|
* </ul>
|
|
*
|
|
* @param rootNodeRef the start of the returned path, or null if the <b>store</b> root
|
|
* node must be assumed.
|
|
* @param nodeRef a reference to the file or folder
|
|
* @return Returns a list of file/folder infos from the root (excluded) down to and
|
|
* including the destination file or folder
|
|
* @throws FileNotFoundException if the node could not be found
|
|
*/
|
|
@Auditable(parameters = {"rootNodeRef", "nodeRef"})
|
|
public List<FileInfo> getNamePath(NodeRef rootNodeRef, NodeRef nodeRef) throws FileNotFoundException;
|
|
|
|
/**
|
|
* Resolve a file or folder name path from a given root node down to the final node.
|
|
*
|
|
* @param rootNodeRef the start point node - a cm:folder type or subtype, e.g. the Company Home's nodeRef
|
|
* @param pathElements a list of names in the path. Do not include the referenced rootNodeRef's path element.
|
|
* @return Returns the info of the file or folder
|
|
* @throws FileNotFoundException if no file or folder exists along the path
|
|
*/
|
|
@Auditable(parameters = {"rootNodeRef", "pathElements"})
|
|
public FileInfo resolveNamePath(NodeRef rootNodeRef, List<String> pathElements) throws FileNotFoundException;
|
|
|
|
/**
|
|
* Get the file info (name, folder, etc) for the given node
|
|
*
|
|
* @param nodeRef the node to get info for
|
|
* @return Returns the file info or null if the node does not represent a file or folder
|
|
*/
|
|
@Auditable(parameters = {"nodeRef"})
|
|
public FileInfo getFileInfo(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get the reader to the file represented by the node according to the File/Folder model.
|
|
* (This is not the same as the method on the ContentService)
|
|
*
|
|
* @param nodeRef the content node
|
|
* @return Returns a handle to the content associated with the node
|
|
*/
|
|
@Auditable(parameters = {"nodeRef"})
|
|
public ContentReader getReader(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Get the writer to the file represented by the node according to the File/Folder model.
|
|
* (This is not the same as the method on the ContentService)
|
|
*
|
|
* @param nodeRef the content node
|
|
* @return Returns a handle to the content associated with the node
|
|
*/
|
|
@Auditable(parameters = {"nodeRef"})
|
|
public ContentWriter getWriter(NodeRef nodeRef);
|
|
|
|
|
|
/**
|
|
* Check the validity of a node reference
|
|
*
|
|
* @return returns <tt>true</tt> if the NodeRef is valid
|
|
*/
|
|
@Auditable(parameters = {"nodeRef"})
|
|
public boolean exists(NodeRef nodeRef);
|
|
|
|
/**
|
|
* Checks the type for whether it is a recognised file or folder type or is invalid for the FileFolderService.
|
|
*
|
|
* @param typeQName the type to check
|
|
* @return - the type
|
|
*/
|
|
@Auditable(parameters = {"typeQName"})
|
|
public FileFolderServiceType getType(QName typeQName);
|
|
}
|