/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.repo.node;
import java.io.Serializable;
import java.util.Map;
import org.alfresco.repo.policy.AssociationPolicy;
import org.alfresco.repo.policy.ClassPolicy;
import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.namespace.QName;
/**
* Node service policies
*
* @author Roy Wetherall
*/
public interface NodeServicePolicies
{
public interface BeforeCreateStorePolicy extends ClassPolicy
{
/**
* Called before a new node store is created.
*
* @param nodeTypeQName the type of the node that will be used for the root
* @param storeRef the reference to the store about to be created
*/
public void beforeCreateStore(QName nodeTypeQName, StoreRef storeRef);
}
public interface OnCreateStorePolicy extends ClassPolicy
{
/**
* Called when a new node store has been created.
*
* @param rootNodeRef the reference to the newly created root node
*/
public void onCreateStore(NodeRef rootNodeRef);
}
public interface BeforeCreateNodePolicy extends ClassPolicy
{
/**
* Called before a new node is created.
*
* @param parentRef the parent node reference
* @param assocTypeQName the association type qualified name
* @param assocQName the association qualified name
* @param nodeTypeQName the node type qualified name
*/
public void beforeCreateNode(
NodeRef parentRef,
QName assocTypeQName,
QName assocQName,
QName nodeTypeQName);
}
public interface OnCreateNodePolicy extends ClassPolicy
{
/**
* Called when a new node has been created.
*
* @param childAssocRef the created child association reference
*/
public void onCreateNode(ChildAssociationRef childAssocRef);
}
public interface OnMoveNodePolicy extends ClassPolicy
{
/**
* Called when a node has been moved.
*
* @param oldChildAssocRef the child association reference prior to the move
* @param newChildAssocRef the child association reference after the move
*/
public void onMoveNode(ChildAssociationRef oldChildAssocRef, ChildAssociationRef newChildAssocRef);
}
public interface BeforeUpdateNodePolicy extends ClassPolicy
{
/**
* Called before a node is updated. This includes the modification of properties, child and target
* associations and the addition of aspects.
*
* @param nodeRef reference to the node being updated
*/
public void beforeUpdateNode(NodeRef nodeRef);
}
public interface OnUpdateNodePolicy extends ClassPolicy
{
/**
* Called after a new node has been created. This includes the modification of properties, child and target
* associations and the addition of aspects.
*
* @param nodeRef reference to the updated node
*/
public void onUpdateNode(NodeRef nodeRef);
}
public interface OnUpdatePropertiesPolicy extends ClassPolicy
{
/**
* Called after a node's properties have been changed.
*
* @param nodeRef reference to the updated node
* @param before the node's properties before the change
* @param after the node's properties after the change
*/
public void onUpdateProperties(
NodeRef nodeRef,
Map<QName, Serializable> before,
Map<QName, Serializable> after);
static Arg ARG_0 = Arg.KEY;
static Arg ARG_1 = Arg.START_VALUE;
static Arg ARG_2 = Arg.END_VALUE;
}
public interface BeforeDeleteNodePolicy extends ClassPolicy
{
/**
* Called before a node is deleted.
*
* @param nodeRef the node reference
*/
public void beforeDeleteNode(NodeRef nodeRef);
}
public interface OnDeleteNodePolicy extends ClassPolicy
{
/**
* Called after a node is deleted. The reference given is for an association
* which has been deleted and cannot be used to retrieve node or associaton
* information from any of the services.
*
* @param childAssocRef the primary parent-child association of the deleted node
* @param isNodeArchived indicates whether the node has been archived rather than purged
*/
public void onDeleteNode(ChildAssociationRef childAssocRef, boolean isNodeArchived);
}
public interface BeforeAddAspectPolicy extends ClassPolicy
{
/**
* Called before an <b>aspect</b> is added to a node
*
* @param nodeRef the node to which the aspect will be added
* @param aspectTypeQName the type of the aspect
*/
public void beforeAddAspect(NodeRef nodeRef, QName aspectTypeQName);
}
public interface OnAddAspectPolicy extends ClassPolicy
{
/**
* Called after an <b>aspect</b> has been added to a node
*
* @param nodeRef the node to which the aspect was added
* @param aspectTypeQName the type of the aspect
*/
public void onAddAspect(NodeRef nodeRef, QName aspectTypeQName);
}
public interface BeforeRemoveAspectPolicy extends ClassPolicy
{
/**
* Called before an <b>aspect</b> is removed from a node
*
* @param nodeRef the node from which the aspect will be removed
* @param aspectTypeQName the type of the aspect
*/
public void beforeRemoveAspect(NodeRef nodeRef, QName aspectTypeQName);
}
public interface OnRemoveAspectPolicy extends ClassPolicy
{
/**
* Called after an <b>aspect</b> has been removed from a node
*
* @param nodeRef the node from which the aspect will be removed
* @param aspectTypeQName the type of the aspect
*/
public void onRemoveAspect(NodeRef nodeRef, QName aspectTypeQName);
}
public interface BeforeCreateNodeAssociationPolicy extends AssociationPolicy
{
/**
* Called before a new node is created with the details of the new child association.
*
* @param parentNodeRef
* @param assocTypeQName the type of the association
* @param assocQName the name of the association
*/
public void beforeCreateNodeAssociation(
NodeRef parentNodeRef,
QName assocTypeQName,
QName assocQName);
}
public interface OnCreateNodeAssociationPolicy extends AssociationPolicy
{
/**
* Called after a node is created with the created association details
*
* @param childAssocRef the child association that has been created
*/
public void onCreateNodeAssociation(ChildAssociationRef childAssocRef);
}
public interface BeforeCreateChildAssociationPolicy extends AssociationPolicy
{
/**
* Called before a node child association is created.
*
* @param parentNodeRef the parent node reference
* @param childNodeRef the child node reference
* @param assocTypeQName the type of the association
* @param assocQName the name of the association
* @param isNewNode <tt>true</tt> if the node is new or <tt>false</tt> if the node is being linked in
*/
public void beforeCreateChildAssociation(
NodeRef parentNodeRef,
NodeRef childNodeRef,
QName assocTypeQName,
QName assocQName,
boolean isNewNode);
}
public interface OnCreateChildAssociationPolicy extends AssociationPolicy
{
/**
* Called after a node child association has been created.
*
* @param childAssocRef the child association that has been created
* @param isNewNode <tt>true</tt> if the node is new or <tt>false</tt> if the node is being linked in
*/
public void onCreateChildAssociation(ChildAssociationRef childAssocRef, boolean isNewNode);
}
public interface BeforeDeleteChildAssociationPolicy extends AssociationPolicy
{
/**
* Called before a node child association is deleted.
*
* @param childAssocRef the child association to be deleted
*/
public void beforeDeleteChildAssociation(ChildAssociationRef childAssocRef);
}
public interface OnDeleteChildAssociationPolicy extends AssociationPolicy
{
/**
* Called after a node child association has been deleted.
*
* @param childAssocRef the child association that has been deleted
*/
public void onDeleteChildAssociation(ChildAssociationRef childAssocRef);
}
public interface OnCreateAssociationPolicy extends AssociationPolicy
{
/**
* Called after a regular node association is created.
*
* @param nodeAssocRef the regular node association that was created
*/
public void onCreateAssociation(AssociationRef nodeAssocRef);
}
public interface OnDeleteAssociationPolicy extends AssociationPolicy
{
/**
* Called after a regular node association is deleted.
*
* @param nodeAssocRef the regular node association that was removed
*/
public void onDeleteAssociation(AssociationRef nodeAssocRef);
}
}