public interface VirtualStore
Handles most virtualized Reference
meta-data interactions analogous
to actual Alfresco public Repository Services.
The Public Repository Services
Modifier and Type | Field and Description |
---|---|
static int |
FILING_OR_MATERIAL_ADHERENCE |
static int |
MATERIAL_ADHERENCE |
Modifier and Type | Method and Description |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
adhere(Reference reference,
int mode) |
boolean |
canMaterialize(Reference reference) |
boolean |
canVirtualize(org.alfresco.service.cmr.repository.NodeRef nodeRef) |
FilingData |
createFilingData(Reference reference,
org.alfresco.service.namespace.QName assocTypeQName,
org.alfresco.service.namespace.QName assocQName,
org.alfresco.service.namespace.QName nodeTypeQName,
Map<org.alfresco.service.namespace.QName,Serializable> properties) |
Set<org.alfresco.service.cmr.security.AccessPermission> |
getAllSetPermissions(Reference reference) |
List<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getChildAssocs(Reference parentReference,
org.alfresco.service.namespace.QNamePattern typeQNamePattern,
org.alfresco.service.namespace.QNamePattern qnamePattern,
int maxResults,
boolean preload)
Gets all child references associations where the pattern of the
association qualified name is an exact match.
|
List<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getChildAssocs(Reference parentReference,
Set<org.alfresco.service.namespace.QName> childNodeTypeQNames)
Retrieve immediate children references of a given reference where the
child nodes are in the given inclusive list.
|
List<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getChildAssocsByPropertyValue(Reference parentReference,
org.alfresco.service.namespace.QName propertyQName,
Serializable value)
Retrieve the immediate children of a given node based on the value of a
property of those children.
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getChildAssocsWithoutParentAssocsOfType(Reference parentReference,
org.alfresco.service.namespace.QName assocTypeQName)
Gets the set of child associations of a certain parent node without
parent associations of a certain type to other nodes with the same
parent! In effect the 'orphans' with respect to a certain association
type.
|
Reference |
getChildByName(Reference parentReference,
org.alfresco.service.namespace.QName assocTypeQName,
String childName)
Get the reference of the virtualized artefact with the given name within
the virtual context (only) of the parent reference.
The name is case-insensitive as Alfresco has to support case-insensitive clients as standard. |
org.alfresco.service.cmr.repository.Path |
getPath(Reference reference) |
Map<org.alfresco.service.namespace.QName,Serializable> |
getProperties(Reference reference) |
NodePermissionEntry |
getSetPermissions(Reference reference) |
org.alfresco.service.namespace.QName |
getType(Reference reference) |
org.alfresco.service.cmr.security.AccessStatus |
hasPermission(Reference reference,
PermissionReference perm)
Check that the given authentication has a particular permission for the
given virtualized artefact.
|
org.alfresco.service.cmr.security.AccessStatus |
hasPermission(Reference reference,
String perm)
Check that the given authentication has a particular permission for the
given virtualized artefact.
|
boolean |
isVirtual(org.alfresco.service.cmr.repository.NodeRef nodeRef) |
List<Reference> |
list(Reference reference)
Lists all immediate children of the referred virtualized artefact.
Note: this could be a long list (and will be trimmed at a pre-configured maximum). |
org.alfresco.query.PagingResults<Reference> |
list(Reference ref,
boolean actual,
boolean virtual,
boolean files,
boolean folders,
String pattern,
Set<org.alfresco.service.namespace.QName> ignoreTypeQNames,
Set<org.alfresco.service.namespace.QName> ignoreAspectQNames,
List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps,
org.alfresco.query.PagingRequest pagingRequest)
Lists page of immediate children of the referred virtualized artefact
with optional filtering (exclusion of certain child file/folder subtypes,
actual-virtual filtering) and sorting.
|
org.alfresco.query.PagingResults<Reference> |
list(Reference ref,
boolean actual,
boolean virtual,
boolean files,
boolean folders,
String pattern,
Set<org.alfresco.service.namespace.QName> searchTypeQNames,
Set<org.alfresco.service.namespace.QName> ignoreTypeQNames,
Set<org.alfresco.service.namespace.QName> ignoreAspectQNames,
List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps,
org.alfresco.query.PagingRequest pagingRequest)
Lists page of immediate children of the referred virtualized artefact
with optional filtering (exclusion of certain child file/folder subtypes,
actual-virtual filtering) and sorting.
Pattern uses '*' as a wildcard |
org.alfresco.query.PagingResults<Reference> |
list(Reference ref,
boolean actual,
boolean virtual,
Set<org.alfresco.service.namespace.QName> searchTypeQNames,
Set<org.alfresco.service.namespace.QName> ignoreTypeQNames,
Set<org.alfresco.service.namespace.QName> ignoreAspectQNames,
List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps,
org.alfresco.query.PagingRequest pagingRequest)
Lists page of immediate children of the referred virtualized artefact
with optional filtering (exclusion of certain child file/folder subtypes,
actual-virtual filtering) and sorting.
|
org.alfresco.service.cmr.repository.NodeRef |
materialize(Reference reference) |
Collection<org.alfresco.service.cmr.repository.NodeRef> |
materializeIfPossible(Collection<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) |
org.alfresco.service.cmr.repository.NodeRef |
materializeIfPossible(org.alfresco.service.cmr.repository.NodeRef nodeRef) |
List<Reference> |
search(Reference reference,
String namePattern,
boolean fileSearch,
boolean folderSearch,
boolean includeSubFolders)
Deprecated.
FileFolderService.search(NodeRef, String, boolean, boolean, boolean)
alignment : for shallow search use list, listFolders,
listFiles, searchSimple. For deep listing use
listDeepFolders. Avoid calling this method with any name
pattern except for "*". |
Reference |
virtualize(org.alfresco.service.cmr.repository.NodeRef nodeRef) |
static final int MATERIAL_ADHERENCE
static final int FILING_OR_MATERIAL_ADHERENCE
Collection<org.alfresco.service.cmr.repository.NodeRef> materializeIfPossible(Collection<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) throws VirtualizationException
VirtualizationException
org.alfresco.service.cmr.repository.NodeRef materializeIfPossible(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws VirtualizationException
VirtualizationException
boolean isVirtual(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws VirtualizationException
VirtualizationException
boolean canVirtualize(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws VirtualizationException
VirtualizationException
Reference virtualize(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws VirtualizationException
VirtualizationException
org.alfresco.service.cmr.repository.NodeRef materialize(Reference reference) throws VirtualizationException
VirtualizationException
org.alfresco.service.cmr.repository.NodeRef adhere(Reference reference, int mode) throws VirtualizationException
VirtualizationException
boolean canMaterialize(Reference reference) throws VirtualizationException
VirtualizationException
org.alfresco.service.cmr.repository.Path getPath(Reference reference) throws VirtualizationException
VirtualizationException
Map<org.alfresco.service.namespace.QName,Serializable> getProperties(Reference reference) throws VirtualizationException
reference
- VirtualizationException
Reference getChildByName(Reference parentReference, org.alfresco.service.namespace.QName assocTypeQName, String childName) throws VirtualizationException
parentReference
- parent Reference
assocTypeQName
- childName
- VirtualizationException
NodeService.getChildByName(org.alfresco.service.cmr.repository.NodeRef,
QName, String)
List<org.alfresco.service.cmr.repository.ChildAssociationRef> getChildAssocs(Reference parentReference, Set<org.alfresco.service.namespace.QName> childNodeTypeQNames)
parentReference
- the parent node - usually a containerchildNodeTypeQNames
- the types that the children may be. Subtypes
are not automatically calculated and the list must therefore
be exhaustive.ChildAssociationRef
instances.List<org.alfresco.service.cmr.repository.ChildAssociationRef> getChildAssocs(Reference parentReference, org.alfresco.service.namespace.QNamePattern typeQNamePattern, org.alfresco.service.namespace.QNamePattern qnamePattern, int maxResults, boolean preload) throws org.alfresco.service.cmr.repository.InvalidNodeRefException
parentReference
- the parent node - usually a containertypeQNamePattern
- the qualified name of the association (
null to ignore)qnamePattern
- the path qualified name (null to ignore)maxResults
- the number of results to getpreload
- true if the nodes must be preloaded into the
cacheChildAssociationRef
instancesorg.alfresco.service.cmr.repository.InvalidNodeRefException
- if the node could not be foundQName
List<org.alfresco.service.cmr.repository.ChildAssociationRef> getChildAssocsByPropertyValue(Reference parentReference, org.alfresco.service.namespace.QName propertyQName, Serializable value)
If the property to be searched is multi-valued then will match on any one values.
Please note, the following system maintained properties that cannot be used with this method.
parentReference
- the parent reference - usually a containerpropertyQName
- the fully qualified name of the propertyvalue
- the value to search for. Must be a simple type such as
String, Number, Date or Boolean, it cannot be a collection, a
content property, MLText or a float.ChildAssociationRef
instances.Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> getChildAssocsWithoutParentAssocsOfType(Reference parentReference, org.alfresco.service.namespace.QName assocTypeQName)
parent
- the parent referenceassocTypeQName
- the association type QNameCollection
of child associationsorg.alfresco.query.PagingResults<Reference> list(Reference ref, boolean actual, boolean virtual, boolean files, boolean folders, String pattern, Set<org.alfresco.service.namespace.QName> searchTypeQNames, Set<org.alfresco.service.namespace.QName> ignoreTypeQNames, Set<org.alfresco.service.namespace.QName> ignoreAspectQNames, List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest) throws VirtualizationException
ref
- actual
- virtual
- files
- folders
- pattern
- ignoreQNames
- searchTypeQNames
- ignoreAspectQNames
- sortProps
- pagingRequest
- VirtualizationException
org.alfresco.query.PagingResults<Reference> list(Reference ref, boolean actual, boolean virtual, boolean files, boolean folders, String pattern, Set<org.alfresco.service.namespace.QName> ignoreTypeQNames, Set<org.alfresco.service.namespace.QName> ignoreAspectQNames, List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest) throws VirtualizationException
ref
- actual
- virtual
- files
- folders
- pattern
- ignoreQNames
- sortProps
- pagingRequest
- VirtualizationException
org.alfresco.query.PagingResults<Reference> list(Reference ref, boolean actual, boolean virtual, Set<org.alfresco.service.namespace.QName> searchTypeQNames, Set<org.alfresco.service.namespace.QName> ignoreTypeQNames, Set<org.alfresco.service.namespace.QName> ignoreAspectQNames, List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest) throws VirtualizationException
VirtualizationException
List<Reference> list(Reference reference) throws VirtualizationException
reference
- VirtualizationException
List<Reference> search(Reference reference, String namePattern, boolean fileSearch, boolean folderSearch, boolean includeSubFolders) throws VirtualizationException
FileFolderService.search(NodeRef, String, boolean, boolean, boolean)
alignment : for shallow search use list, listFolders,
listFiles, searchSimple. For deep listing use
listDeepFolders. Avoid calling this method with any name
pattern except for "*".Reference
hierarchy. reference
- namePattern
- fileSearch
- folderSearch
- includeSubFolders
- VirtualizationException
org.alfresco.service.namespace.QName getType(Reference reference) throws VirtualizationException
reference
- VirtualizationException
FilingData createFilingData(Reference reference, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName nodeTypeQName, Map<org.alfresco.service.namespace.QName,Serializable> properties) throws VirtualizationException
reference
- assocTypeQName
- assocQName
- nodeTypeQName
- properties
- FilingData
of the given parent locationVirtualizationException
org.alfresco.service.cmr.security.AccessStatus hasPermission(Reference reference, String perm) throws VirtualizationException
reference
- perm
- AccessStatus
VirtualizationException
org.alfresco.service.cmr.security.AccessStatus hasPermission(Reference reference, PermissionReference perm) throws VirtualizationException
reference
- perm
- AccessStatus
VirtualizationException
NodePermissionEntry getSetPermissions(Reference reference) throws VirtualizationException
VirtualizationException
Copyright © 2005–2017 Alfresco Software. All rights reserved.