org.alfresco.repo.model.filefolder
Class HiddenAspect

java.lang.Object
  org.alfresco.repo.model.filefolder.HiddenAspect

public class HiddenAspect
extends java.lang.Object

Functionality relating to hidden files and folders. Support for nodes marked as hidden but with visibility constraints for specific clients. A node can have the hidden aspect applied, which means that the node is hidden. However, for specific clients it can be defined whether the node is visible or will have its hidden attribute set in FileInfo.

Nested Class Summary

static class

HiddenAspect.Visibility

Constructor Summary

HiddenAspect()

Method Summary

void	checkHidden(FileInfoImpl fileInfo) Checks whether the file should be hidden and applies the hidden and not indexed aspects if so.
HiddenFileInfo	checkHidden(org.alfresco.service.cmr.repository.NodeRef nodeRef) Checks whether the file should be hidden and applies the hidden and not indexed aspects if so.
org.alfresco.util.FileFilterMode.Client[]	getClients()
int	getClientVisibilityMask(org.alfresco.util.FileFilterMode.Client client, HiddenAspect.Visibility visibility)
HiddenAspect.Visibility	getVisibility(org.alfresco.util.FileFilterMode.Client client, org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the visibility constraint for the given client on the given node.
void	hideNode(FileInfoImpl fileInfo, int visibilityMask) Hides the node by applying the hidden and not indexed aspects.
void	hideNode(org.alfresco.service.cmr.repository.NodeRef nodeRef) Hides the node by applying the hidden and not indexed aspects.
void	hideNode(org.alfresco.service.cmr.repository.NodeRef nodeRef, int clientVisibilityMask) Hides the node by applying the hidden and not indexed aspects.
HiddenFileInfo	isHidden(org.alfresco.service.cmr.repository.NodeRef nodeRef) Checks whether the node is on a hidden path
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPatterns(java.util.List filters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HiddenAspect

public HiddenAspect()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setPatterns

public void setPatterns(java.util.List filters)

getClients

public org.alfresco.util.FileFilterMode.Client[] getClients()

getClientVisibilityMask

public int getClientVisibilityMask(org.alfresco.util.FileFilterMode.Client client,
                                   HiddenAspect.Visibility visibility)

isHidden

public HiddenFileInfo isHidden(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Checks whether the node is on a hidden path

Parameters:

nodeRef -

Returns:

the matching filter, or null if no match

hideNode

public void hideNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Hides the node by applying the hidden and not indexed aspects. The node will be hidden from all clients.

Parameters:

client -

fileInfo -

hideNode

public void hideNode(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                     int clientVisibilityMask)

Hides the node by applying the hidden and not indexed aspects. The node will be hidden from clients according to the visibility mask.

Parameters:

client -

fileInfo -

checkHidden

public void checkHidden(FileInfoImpl fileInfo)

Checks whether the file should be hidden and applies the hidden and not indexed aspects if so.

Parameters:

fileInfo -

hideNode

public void hideNode(FileInfoImpl fileInfo,
                     int visibilityMask)

Hides the node by applying the hidden and not indexed aspects. The node will be hidden from clients according to the visibility mask.

Parameters:

client -

fileInfo -

checkHidden

public HiddenFileInfo checkHidden(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Checks whether the file should be hidden and applies the hidden and not indexed aspects if so.

Parameters:

fileInfo -

Returns:

getVisibility

public HiddenAspect.Visibility getVisibility(org.alfresco.util.FileFilterMode.Client client,
                                             org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the visibility constraint for the given client on the given node.

Parameters:

client -

nodeRef -

Returns:

the visibility constraint for the given client and node