Paul Holmes-Higgin cefda8c965 Updated header to LGPL
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18931 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-03-01 22:48:39 +00:00

182 lines
5.3 KiB
Java

/*
* Copyright (C) 2005-2010 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.repo.domain;
import org.alfresco.repo.domain.qname.QNameDAO;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.namespace.QName;
/**
* Represents a special type of association between nodes, that of the
* parent-child relationship.
*
* @author Derek Hulley
*/
public interface ChildAssoc extends Comparable<ChildAssoc>
{
/**
* Performs the necessary work on the provided nodes to ensure that a bidirectional
* association is properly set up.
* <p>
* The association attributes still have to be set up.
*
* @param parentNode
* @param childNode
*
* @see #setName(String)
* @see #setIsPrimary(boolean)
*/
public void buildAssociation(Node parentNode, Node childNode);
/**
* Performs the necessary work on the {@link #getParent() parent} and
* {@link #getChild() child} nodes to maintain the inverse association sets
*/
public void removeAssociation();
/**
* A convenience method to get a reference to this association.
*
* @param qnameDAO the DAO to resolve the qname references
* @return Returns a reference to this association
*/
public ChildAssociationRef getChildAssocRef(QNameDAO qnameDAO);
/**
* Convenience method to get the association's type
*
* @param qnameDAO the helper DAO
* @return the association's type QName
*/
public QName getTypeQName(QNameDAO qnameDAO);
/**
* Convenience method to set the association's type
*
* @param qnameDAO the helper DAO
* @param typeQName the association's type QName
*/
public void setTypeQName(QNameDAO qnameDAO, QName typeQName);
/**
* A convenience method to aggregate the qualified name's namespace and localname
* into a single qualified name.
*
* @return Returns the qualified name of the association
*/
public QName getQName(QNameDAO qnameDAO);
/**
* Convenience method to set the association's qname
*
* @param qnameDAO the helper DAO
* @param qname the association's QName
*/
public void setQName(QNameDAO qnameDAO, QName qname);
public Long getId();
/**
* @return Return the current version number
*/
public Long getVersion();
public Node getParent();
public Node getChild();
/**
* @return Returns the type of the association
*/
public Long getTypeQNameId();
/**
* @param typeQNameId the association's dictionary type
*/
public void setTypeQNameId(Long typeQNameId);
/**
* @return Returns the child node name. This may be truncated, in which case it
* will end with <b>...</b>
*/
public String getChildNodeName();
/**
* @param childNodeName the name of the child node, which may be truncated and
* terminated with <b>...</b> in order to not exceed 50 characters.
*/
public void setChildNodeName(String childNodeName);
/**
* @return Returns the crc value for the child node name.
*/
public long getChildNodeNameCrc();
/**
* @param crc the crc value
*/
public void setChildNodeNameCrc(long crc);
/**
* @return Returns the namespace of the association's local QName
*/
public Long getQnameNamespaceId();
/**
* @param namespaceId the namespace of the association's local QName
*/
public void setQnameNamespaceId(Long namespaceId);
/**
* @return Returns the localname of the association's local QName
*/
public String getQnameLocalName();
/**
* @param localName the localname of the association's local QName
*/
public void setQnameLocalName(String localName);
/**
* @return Returns the crc value for the association's local QName
*/
public long getQnameCrc();
/**
* @param crc the crc value
*/
public void setQnameCrc(long crc);
public boolean getIsPrimary();
public void setIsPrimary(boolean isPrimary);
/**
* @return Returns the user-assigned index
*/
public int getIndex();
/**
* Set the index of this association
*
* @param index the association index
*/
public void setIndex(int index);
}